Skip to content

Documentation #36

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

Open
DaveOri opened this issue Jun 15, 2022 · 2 comments
Open

Documentation #36

DaveOri opened this issue Jun 15, 2022 · 2 comments

Comments

@DaveOri
Copy link
Collaborator

DaveOri commented Jun 15, 2022

readthedocs is broken. Probably some errors in the compilation prevents from filling the pages with autodocs.

I also received some requests from users to improve the documentation. General points would be:

  • description of input and outputs, with units
  • more clear examples (not sure how to get this, maybe some different use-cases)
  • description of the domain (x,y,z,time). Difference between _lev and layer coordinates, something like that...

I will try to start a github project on this. There are going to be several sub-issues and assignments to address. Any contribution will be helpful, even just writing tasks in the to-do list would be great

@spirrobe
Copy link
Contributor

spirrobe commented Oct 4, 2023

I had a look at using pamtra myself and ran the make htmldoc which shows that the error is basically an unescaped | in the settings.rst
As an intermediate solution I put the doc on our ETHZ server: https://iacweb.ethz.ch/staff/rspirig/pamtra/
I'll open a PR with the fix (| -> |)
This does of course not cover the rest of your listed improvements.

@maahn
Copy link
Collaborator

maahn commented Nov 22, 2024

I fixed readthedocs: 9de11da

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

No branches or pull requests

3 participants