ansys / ansys/pyedb-core

Convert our documentation to new versioned documentation

Open
#227 1 comment 0 reactions 1 assignee Claimed by @bwnedrud View on GitHub
documentation
Dominant language
Python
Stars
7
Forks
4
PR merge metrics
No merged PRs in 30d

Description

### Description of the modifications

At the PyAnsys core team we are trying to "get rid" of the dev.* documentation sites that the different projects have in favor of implementing a multi-version scheme in their docs (being one of the versions the "dev" status of the repo). We have communicated this effort a couple of times in the Thursday meetings, and we are approaching the teams individually to check their status.
This multi-version mechanism will allow us:
• To have a single location for all the docs related to the PyAnsys project
• Ease maintenance tasks
• And most importantly - solve some IT security issues that were risen to us.
We have given all PyAnsys teams till end of March as deadline for changing to the multi-versioning system. We (as in the PyAnsys core team) can provide support on the change, but it eventually has to happen.
PyEDB has two docs sites (as most projects used to have):
• dev.edb.docs.pyansys.com
• edb.docs.pyansys.com
My questions are:
• Do you need any support doing so? (guidelines, actual coding help etc.)
An example of multi-versioning docs site can be found here: https://mapdl.docs.pyansys.com/

### Useful links and references

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.