Skip to content

Improve API reference in the docs #143

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
Closed
2 tasks
Tracked by #5
RobPasMue opened this issue Sep 29, 2022 · 1 comment · Fixed by #158
Closed
2 tasks
Tracked by #5

Improve API reference in the docs #143

RobPasMue opened this issue Sep 29, 2022 · 1 comment · Fixed by #158
Assignees
@Revathyvenugopal162
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 Sep 29, 2022 •
edited
Loading

Though our API reference documentation looks good enough for now, we should rework it. Some tasks:

  • Modify the template so that the landing page is not as overwhelming as it is right now (see PyMAPDL for example)
  • Improve the docstrings to properly link to all objects. Some of the objects in the library are not being linked properly. We should go through all entries in the docstrings and reformat them as needed. This might be time consuming but a necessary task.
@RobPasMue RobPasMue mentioned this issue Sep 29, 2022
Closed
5 tasks
@RobPasMue RobPasMue changed the title API reference Improve API reference in the docs Sep 29, 2022
@RobPasMue RobPasMue added PRIORITY Issue/PR assigned with this tag must be given priority over the rest of the backlog documentation Improvements or additions to documentation labels Sep 29, 2022
@RobPasMue
Copy link
Member Author

Thanks to @MaxJPRey for pinging us on ansys/pydpf-post#169

We should definitely consider using this!!

@RobPasMue RobPasMue linked a pull request Oct 5, 2022 that will close this issue
Improve docs for API references #158
Merged
@Revathyvenugopal162 Revathyvenugopal162 mentioned this issue Oct 7, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Revathyvenugopal162 Revathyvenugopal162

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
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve docs for API references ansys/pyansys-geometry
2 participants
@RobPasMue @Revathyvenugopal162