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.

Sign up for GitHub

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

Jump to bottom

Rebuilding documentation #76

Open
3 tasks
mlincett opened this issue Jul 6, 2022 · 0 comments
Open
3 tasks

Rebuilding documentation #76

mlincett opened this issue Jul 6, 2022 · 0 comments

Comments

@mlincett
Copy link
Contributor

mlincett commented Jul 6, 2022

The published documentation is not aligned with the docstrings (notably UNITS placeholders are still there).

  • documentation in docs needs to be rebuilt and pushed to the repository;
  • It could be nice to add instructions to the README on how to build documentation. Installing and running pdoc seems straightforward but LaTeX does not render (what dependencies should be satisfied?);
  • can this be automatised with a GitHub Action?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mlincett