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

Improve documentation sections #5

Closed
5 tasks done
RobPasMue opened this issue Aug 30, 2022 · 4 comments · Fixed by #183
Closed
5 tasks done

Improve documentation sections #5

RobPasMue opened this issue Aug 30, 2022 · 4 comments · Fixed by #183
Assignees
Labels
documentation Improvements or additions to documentation PRIORITY Issue/PR assigned with this tag must be given priority over the rest of the backlog

Comments

@RobPasMue
Copy link
Member

RobPasMue commented Aug 30, 2022

At the moment the docs are a clean sheet. We should consider implementing the basic sections of all PyAnsys docs:

@RobPasMue
Copy link
Member Author

They don't have to be full of information. It's just creating the structure. Except for Getting started.

@jorgepiloto jorgepiloto added the documentation Improvements or additions to documentation label Aug 30, 2022
@jorgepiloto
Copy link
Member

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.

@MaxJPRey
Copy link
Contributor

@jorgepiloto Yes based on the limited amount of time we have, we can set this up first.
Then we can setup a "regular/usual" pyansys doc later.

@RobPasMue
Copy link
Member Author

That'd be great @jorgepiloto, we can always come back to it later. Thanks!!

@RobPasMue RobPasMue mentioned this issue Aug 30, 2022
9 tasks
@RobPasMue RobPasMue changed the title Create documentation sections Improve documentation sections Sep 29, 2022
@RobPasMue RobPasMue added the PRIORITY Issue/PR assigned with this tag must be given priority over the rest of the backlog label Sep 29, 2022
@RobPasMue RobPasMue linked a pull request Oct 21, 2022 that will close this issue
3 tasks
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 PRIORITY Issue/PR assigned with this tag must be given priority over the rest of the backlog
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants