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

Implement pdoc/sphinx or similar for code documentation #380

Closed
denised opened this issue Aug 2, 2021 · 4 comments
Closed

Implement pdoc/sphinx or similar for code documentation #380

denised opened this issue Aug 2, 2021 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@denised
Copy link
Member

denised commented Aug 2, 2021

There is extensive triple-quote documentation in the code, especially the model code. We would like to have a nicely formatted and indexed version of this documentation available for developers or researchers who are using the code.

I have an idea that that we might use the github "pages" feature to host the documentation, but totally open to other suggestions.

@denised denised added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 2, 2021
@yaswanthkumargothi
Copy link

Hello @denised, I would like to work on this.

@denised
Copy link
Member Author

denised commented Aug 4, 2021

Awesome, I will assign it to you! Let me know if I can help.

@yaswanthkumargothi
Copy link

Thanks @denised, will keep you updated on the documentation.

@denised
Copy link
Member Author

denised commented Jan 22, 2022

This took me a lot longer to do than I expected it to, but I got there!
Our online documentation is now at [https://projectdrawdown.github.io/solutions/]
The part that has been finished is:

  • The infrastructure that extracts the documentation that is already part of the code and converts that to HTML. This is in Documentation/autodocs.
  • A process that automatically runs whenever new code is checked in, so the online documentation is always kept up to date. This is the file builddocs.sh in Documentation/autodocs, and the github actions configuration in the .github folder.

There is additional work needed to improve the content of the documentation --- I'll treat that as falling under issue #494.

@denised denised closed this as completed Jan 22, 2022
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants