-
Notifications
You must be signed in to change notification settings - Fork 177
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Description and motivation
While revising the readthedocs integration (#576), a number of slight discrepancies between the apidocs structure and the current module structure was found. It would be great to regenerate the docs/source/api/ folder, to ensure the rendered documentation contains the right set of entries for the modules.
Proposed solution
Refresh the contents of the folder via:
- installing the package (to avoid
rpu_basestub deletion) - remove the current files (
rm -r docs/source/api/*.rst) - regenerate the stubs (
cd docs; make apidoc) - sanity check on the rendered output, ensuring the content is correct
Alternatives and other information
- It might be needed to tweak the
apidocmakefile target at https://github.com/IBM/aihwkit/blob/master/docs/Makefile#L22 in order to add extra files related to inference. - Also,
docs/source/api_reference.rstmight need to be updated manually. Originally, the file only contained the second-level modules, mostly to avoid having to keep it manually updated and just be able to delegate ontodocs/source/api/aiwhkit.rst(which is automatically regenerated via themake apidoccommand) for the full information.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation