docs: reformat the documentation

ansys / ansys-sphinx-theme

PyData-based Sphinx theme from the PyAnsys community

https://sphinxdocs.ansys.com

MIT License

21 stars 5 forks source link

docs: reformat the documentation #396

Closed Revathyvenugopal162 closed 1 week ago

Revathyvenugopal162 commented 4 weeks ago

fix #373 #404 This pull request enhances the documentation for the Ansys Sphinx theme with the following updates:

User Guide: Updated to include comprehensive information.
Examples: Added demonstrations of style changes for all applicable extensions.
Copyright: Ensured proper attribution for examples, particularly from Sphinx Design and Admonitions, which were directly downloaded.

jorgepiloto commented 1 week ago

Also, could we have the same example for both nbsphinx and sphinx-gallery? I will add another one for the jupytext approach.

Revathyvenugopal162 commented 1 week ago

Also, could we have the same example for both nbsphinx and sphinx-gallery? I will add another one for the jupytext approach.

sure, i can add that.

Revathyvenugopal162 commented 1 week ago

Thank you for the detailed review, @PipKat. I have addressed all the comments, I hope you can open a documentation review at your convenience once this PR is merged as mentioned above.