-
Notifications
You must be signed in to change notification settings - Fork 17
Improve documentation sections #5
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
Comments
They don't have to be full of information. It's just creating the structure. Except for |
Let me work on this. What do you think about using https://sphinx-autoapi.readthedocs.io/en/latest/? I will save us a lot of time, as the API reference gets automatically generated. No need to have any RST files, everything builds on the fly when rendering the docs. |
@jorgepiloto Yes based on the limited amount of time we have, we can set this up first. |
That'd be great @jorgepiloto, we can always come back to it later. Thanks!! |
Uh oh!
There was an error while loading. Please reload this page.
At the moment the docs are a clean sheet. We should consider implementing the basic sections of all PyAnsys docs:
Examples
section of the documentation #141Getting started
section to the documentation #142User guide
section to the docs #144Contributing
section to the docs #145The text was updated successfully, but these errors were encountered: