You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We ought to generate some API documentation for LinkRun and all the related classes and functions that are part of hlink's API. These docs could be linked to from the current hlink.docs.ipums.org website, or they could be a subsection of that site.
I'm pretty sure that Sphinx is capable of generating this sort of documentation, so let's try that out sometime since we're already using Sphinx.
The text was updated successfully, but these errors were encountered:
I looked into this, and with a combination of sphinx.ext.autodoc and sphinx.ext.napoleon, we should be able to generate nice documentation for the API. We may want to rework some of our docstrings to make them link to each other and look nice in Sphinx. One nice part about this process is that we can work directly in the sphinx-docs/ directory and have these pages be a part of the already-existing documentation.
We ought to generate some API documentation for
LinkRun
and all the related classes and functions that are part of hlink's API. These docs could be linked to from the current hlink.docs.ipums.org website, or they could be a subsection of that site.I'm pretty sure that Sphinx is capable of generating this sort of documentation, so let's try that out sometime since we're already using Sphinx.
The text was updated successfully, but these errors were encountered: