Skip to content
New issue

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

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

Already on GitHub? # to your account

Update readme docs #46

Merged
merged 17 commits into from
Jan 8, 2025
Merged

Update readme docs #46

merged 17 commits into from
Jan 8, 2025

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

@coveralls
Copy link

coveralls commented Jan 3, 2025

Coverage Status

coverage: 73.991%. remained the same
when pulling 4774e93 on update-readme-docs
into c5bf64f on main.

Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
@github-actions github-actions bot added the CI label Jan 3, 2025
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
@coxipi coxipi force-pushed the update-readme-docs branch from dab6bb2 to 2f4178f Compare January 8, 2025 20:32
@Zeitsperre
Copy link
Contributor

@coxipi This is just missing the pygments pin and I think we're good here!

@coxipi coxipi merged commit ff912c5 into main Jan 8, 2025
14 checks passed
@coxipi coxipi deleted the update-readme-docs branch January 8, 2025 21:39
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants