search

ansys / ansys-sphinx-theme

PyData-based Sphinx theme from the PyAnsys community
https://sphinxdocs.ansys.com
MIT License
21 stars 5 forks source link

Improve the documentation #373

Closed jorgepiloto closed 1 week ago

jorgepiloto commented 1 month ago

Years have passed and this theme has evolved into a more mature project. New hooks and extensions are available. However, the documentation is dragging behind the development.

We need to ensure the following sections:

- Getting started
  - Installation
    - Users
    - Developers

- User guide
  - Basics
  - Extensions
    - Multi-version docs 
    - PyMeilisearch
    - Autoapi
    - Others?

- Examples
- Changelog
jorgepiloto commented 1 month ago

Note that most of the content is in place. We just need to refactor it.

RobPasMue commented 1 month ago

Agreed - this would be great to have!