Documentation implementation

[germa89]

Context

There are multiple versions of MAPDL (v23.1; ... v22.1). Most of the functions do not change between versions, but there are some of them which get new documentation.

Current documentation docstring are based (I believe) in v19.1 or so. They were parsed from a third party html so it is not perfect, neither complete (long commands , i.e. *GET got trimmed)

An update and organized documentation is a requirement for all high quality projects. Good quality documentation should include versioning, and updated docs.

Approach

Since we recently got access the documentation source code, we can plan around including them in the docs strings of each mapdl method.

Stages

• [ ] Dynamically generate docstrings from XML documentation files #774
• [ ] Trim or redirect long docstrings to specific pages in the documentation #874
• [ ] Update docstrings when the function signature is changed (overwriting the docstring)
  • [ ] Hardcoding the changes. It will be overwritten every time that we regenerate the docstrings (git merge?)
  • [ ] Using docstring injection. However the sphinx documentation (html) won't be updated. #978
• [ ] Consistently versioning the documentation using readthedocs. I would suggest here to use:
  • [ ] The readthedocs versions for the PyMAPDL versions, and
  • [ ] Annotate the changes on the MAPDL side as RST annotations (warnings, notes, ammonitions, etc)

Stages