Skip to content
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

Generate API documentation #49

Open
riley-harper opened this issue Oct 13, 2022 · 2 comments
Open

Generate API documentation #49

riley-harper opened this issue Oct 13, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@riley-harper
Copy link
Contributor

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.

@riley-harper riley-harper added the documentation Improvements or additions to documentation label Oct 13, 2022
@riley-harper
Copy link
Contributor Author

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.

@riley-harper
Copy link
Contributor Author

Things to include in the documentation:

  • LinkRun
  • LinkTask
  • LinkStep
  • Table
  • hlink.scripts.lib modules, like io and conf_validations
  • hlink.configs.load_config
  • SparkFactory and maybe SparkConnection

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant