Skip to content

doc: update documentation to match PyAnsys standards#63

Merged
jorgepiloto merged 13 commits into
mainfrom
doc/updates
May 28, 2024
Merged

doc: update documentation to match PyAnsys standards#63
jorgepiloto merged 13 commits into
mainfrom
doc/updates

Conversation

@jorgepiloto

@jorgepiloto jorgepiloto commented May 17, 2024

Copy link
Copy Markdown
Member

This pull-request includes the following changes for improving the documentation:

  • Adds a tox.ini file for automating project builds
  • Uses rST for documentation files
  • Ensures slugs and short names are used for doc files
  • Implements Jinja environments for conditionally building doc sections

@github-actions github-actions Bot added dependencies Related with project dependencies maintenance Package and maintenance related documentation Improvements or additions to documentation labels May 17, 2024
@jorgepiloto jorgepiloto marked this pull request as ready for review May 17, 2024 13:51
@jorgepiloto jorgepiloto requested a review from franknli May 17, 2024 13:52
@jorgepiloto jorgepiloto mentioned this pull request May 23, 2024
10 tasks
@jorgepiloto jorgepiloto requested a review from PipKat as a code owner May 27, 2024 08:31
@jorgepiloto jorgepiloto requested a review from a team as a code owner May 28, 2024 07:30
@jorgepiloto jorgepiloto merged commit 7a61ef4 into main May 28, 2024
@jorgepiloto jorgepiloto deleted the doc/updates branch May 28, 2024 08:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Related with project dependencies documentation Improvements or additions to documentation maintenance Package and maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants