-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
API documentation missing links #66
Comments
Noticed some other issues on this page: https://docs.flamegpu.com/guide/3-behaviour-definition/6-host-functions.html Bullets not formatted correctly: Something odd going on around |
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.... |
https://exhale.readthedocs.io/en/latest/usage.html#linking-to-a-generated-file This appears to be the guidance, will test. |
And if you want custom text, you use something like this
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. |
The more info block at the bottom of |
In a number of places (atleast 6) there are links intending to link to API docs, which do not do so.
The ones i've found are of the pattern:
Full API documentation for the ``X``: link
Where
X
is the name of a class, such aasEnvironmentDescription
.We could hardcode links to the hosted API docs, but this feels brittle. There should be a breathe/exhale way of finding the correct link, although I'm not sure exactly how.
Additionally, as the api docs are an optional part of the docs project, these links will only exist if the API docs are being built, which is (suprisingly) expensive in terms or time.
src/guide/6-agent-birth-death/1-agent-birth-device.rst:149
src/guide/6-agent-birth-death/3-agent-death.rst:53
src/guide/2-model-definition/3-agent.rst:152
src/guide/2-model-definition/2-environment.rst:137
src/guide/2-model-definition/1-model.rst:31
src/guide/3-behaviour-definition/1-defining-agent-functions.rst:170
The text was updated successfully, but these errors were encountered: