Giter Club home page Giter Club logo

Comments (6)

Robadob avatar Robadob commented on June 24, 2024

Noticed some other issues on this page: https://docs.flamegpu.com/guide/3-behaviour-definition/6-host-functions.html

Bullets not formatted correctly:
image

Something odd going on around uniform here:

image

from flamegpu2-docs.

Robadob avatar Robadob commented on June 24, 2024

I wasn't aware of this issue when I was fixing cross ref's the other day, only noticed this earlier today, will try and address all the issues tomorrow. Just noticed they're cross ref's to API docs, might be a tad harder....

from flamegpu2-docs.

Robadob avatar Robadob commented on June 24, 2024

https://exhale.readthedocs.io/en/latest/usage.html#linking-to-a-generated-file

This appears to be the guidance, will test.

from flamegpu2-docs.

Robadob avatar Robadob commented on June 24, 2024

Ok so writing

* Full API documentation for the ``EnvironmentDescription``: :class:`flamegpu::EnvironmentDescription`

produces a link like this.
image

And the link goes to api/classflamegpu_1_1_environment_description.html#_CPPv4N8flamegpu22EnvironmentDescriptionE

image

from flamegpu2-docs.

Robadob avatar Robadob commented on June 24, 2024

And if you want custom text, you use something like this

* Full API documentation for the ``EnvironmentDescription``: :class:`custom text<flamegpu::EnvironmentDescription>`

Not clear how to get rid of the inline code style, but that's probably not an issue, this will just allow us to omit the namespace inline.

image

from flamegpu2-docs.

Robadob avatar Robadob commented on June 24, 2024

The more info block at the bottom of src/guide/6-agent-birth-death/3-agent-death.rst:53 isn't even relevant, it appears copy pasted from a page related to environment.

from flamegpu2-docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.