Skip to content

Changes in the general documentation layout #1762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 6 commits into from
Closed

Changes in the general documentation layout #1762

wants to merge 6 commits into from

Conversation

@luisaFelixSalles
Copy link
Contributor

@luisaFelixSalles luisaFelixSalles commented Sep 19, 2024 •
edited by PProfizi
Loading

This PR make some general changes in the documentation web site

  • Update to the 1.0.8 version of ansys_sphix_theme
  • Adaptation of the PyAnsys logo for light and dark modes
  • Add a file with substitution text to be used around the doc for supported file formats per solver
  • Move the "Concepts" section into the "User guide" section
  • Add new extension in the conf file: "sphinx_exec_code" https://github.com/spacemanspiff2007/sphinx-exec-code

@luisaFelixSalles luisaFelixSalles added the documentation Improvements or additions to documentation label Sep 19, 2024
@luisaFelixSalles luisaFelixSalles self-assigned this Sep 19, 2024
@luisaFelixSalles luisaFelixSalles mentioned this pull request Sep 17, 2024
Closed
15 tasks
@luisaFelixSalles @PProfizi
Changes in the user guide layout (#1763)
2d4f565 
* add concepts intro in the user guide index page

* add tutorials concept (from the main entities documents)

* organise and adapt the how-to section

* organise and adapt the troubleshooting section

* organise and adapt the troubleshooting section and final sidebar

* changes in the troubleshooting index page

* changes in the how to index page

* changes in the concepts index page

* changes in the layout of the index pages

* Apply suggestions from code review

Co-authored-by: Paul Profizi <[email protected]>

* corrections after first revision

* Apply suggestions from code review

Co-authored-by: Paul Profizi <[email protected]>

* Add sphinx-exec-code to doc requirements

* corrections files path

* Apply suggestions from code review

Co-authored-by: Paul Profizi <[email protected]>

* Apply suggestions from code review

Co-authored-by: Paul Profizi <[email protected]>

---------

Co-authored-by: Paul Profizi <[email protected]>
@PProfizi PProfizi closed this Nov 13, 2024
@PProfizi PProfizi deleted the doc/general-layout branch November 28, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@PProfizi PProfizi Awaiting requested review from PProfizi

Assignees

@luisaFelixSalles luisaFelixSalles

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@luisaFelixSalles @PProfizi