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

Update readme docs #46

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Update readme docs #46

wants to merge 6 commits into from

Conversation

coxipi
Copy link
Contributor

@coxipi coxipi commented Dec 17, 2024

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes #xyz
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • CHANGELOG.rst has been updated (with summary of main changes).
    • Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

  • More documentation, intended especially for readthedocs.

Does this PR introduce a breaking change?

No

Other information:

@github-actions github-actions bot added the docs label Dec 17, 2024
@Zeitsperre
Copy link
Contributor

I think I know what's wrong here: You're using html_theme_options that are specific to the furo theme. I think we can justify replacing sphinx_rtd_theme with furo (it's nicer, IMO).

… formatting, add option to not run notebooks
@Zeitsperre
Copy link
Contributor

@coxipi

I think we just need to merge the main branch and deal with the strange CSS issue I pointed out. We'll be good to make a release after that!

@coxipi
Copy link
Contributor Author

coxipi commented Dec 18, 2024

Ok, I will push a couple more changes, just checking the docs before

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants