search

AllenNeuralDynamics / aind-behavior-curriculum

Starter repository for behavior base primitives.
https://aind-behavior-curriculum.readthedocs.io
MIT License
1 stars 0 forks source link

Improve docs cross-referencing #24

Closed bruno-f-cruz closed 1 month ago

bruno-f-cruz commented 1 month ago

We should consider refactoring the docs website to cross-reference with the API documentation of the package. For instance, Metrics should link to the respective technical reference instead of just highlighting the word. Additionally, we should consider splitting the technical documentation by module instead of flattening the whole thing. As an example:

The callables in **Policy** and ...

should be replaced by:

The callables in :py:class:`~aind_behavior_curriculum.curriculum.Policy` and...
jwong-nd commented 1 month ago

Agree with this, can lump into the next PR