Skip to content
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.

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

Updating the documentation #60

Merged
merged 10 commits into from
Feb 28, 2024
Merged

Updating the documentation #60

merged 10 commits into from
Feb 28, 2024

Conversation

SilvestriStefano
Copy link
Collaborator

@SilvestriStefano SilvestriStefano commented Oct 5, 2023

I am updating the documentation website to (hopefully) make it easier to mantain in the future.

Goals

  • update environment file
  • update contributing documentation
  • Example gallery with nbsphinx
  • use sphinx-design and avoid using .. raw::html
  • remove superfluous/unused files
  • fix sphinx warnings
  • configuration file for ReadTheDocs

@SilvestriStefano SilvestriStefano added the website Issuess regarding the website management label Oct 5, 2023
@SilvestriStefano SilvestriStefano self-assigned this Oct 5, 2023
@SilvestriStefano SilvestriStefano marked this pull request as draft October 5, 2023 09:47
:doc:`type_setup() <../../api/time_evolution_subpckg/Integrator_mthds/sarkas.time_evolution.integrators.Integrator.type_setup>`
links the chosen integrator to the :doc:`update() <../../api/time_evolution_subpckg/Integrator_mthds/sarkas.time_evolution.integrators.Integrator.update>` method which evolves
`type_setup() <../../api/time_evolution_subpckg/Integrator_methods/sarkas.time_evolution.integrators.Integrator.type_setup.rst>`_
links the chosen integrator to the `update() <../../api/time_evolution_subpckg/Integrator_methods/sarkas.time_evolution.integrators.Integrator.update.rst>`_ method which evolves
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lucianogsilvestri there is no update method in the Integrator class, so to what should this link?

@SilvestriStefano SilvestriStefano marked this pull request as ready for review December 12, 2023 06:41
@lucianogsilvestri lucianogsilvestri merged commit 02dd14b into dev Feb 28, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
website Issuess regarding the website management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants