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 documentation theme #125

Merged
merged 3 commits into from
Oct 20, 2022
Merged

Update documentation theme #125

merged 3 commits into from
Oct 20, 2022

Conversation

bvreede
Copy link
Contributor

@bvreede bvreede commented Oct 18, 2022

This PR updates the documentation theme; this way, we don't have to look at the ugly alabaster theme when we update the documentation 🙃

We have changed the settings on Readthedocs so it will automatically show a preview of documentation as part of a PR. Follow the link below (in the checks) or see the updated docs here.

This was (eventually) found in Admin > Advanced settings > Build pull requests for this project.

@codecov
Copy link

codecov bot commented Oct 18, 2022

Codecov Report

❗ No coverage uploaded for pull request base (main@970226a). Click here to learn what that means.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #125   +/-   ##
=======================================
  Coverage        ?   98.94%           
=======================================
  Files           ?        6           
  Lines           ?      379           
  Branches        ?        0           
=======================================
  Hits            ?      375           
  Misses          ?        4           
  Partials        ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 970226a...6a0cd65. Read the comment docs.

@bvreede bvreede changed the title Update documentation Update documentation theme Oct 18, 2022
Copy link
Member

@BSchilperoort BSchilperoort left a comment

Choose a reason for hiding this comment

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

Hi Barbara, this theme does look a lot better! Nice that you got the PR-doc build enabled as well, that can really help with reviewing changes to the docs.

I was wondering why there are three docs-related badges in ./README.rst though. Perhaps that can be reduced to only show the docs status as there is another link to the documentation at the bottom of the readme :)

@bvreede
Copy link
Contributor Author

bvreede commented Oct 20, 2022

Thanks @BSchilperoort — yeah, very good point, it's indeed a bit excessive. The main advantage is that there is an explicit reference to stable vs latest documentation, but honestly, there should not really be a (big) difference between those, and it's really only confusing.

I've now changed the status badge to refer to "latest" documentation (which is also what the link at the bottom of the README refers to), and removed the two other docs badges.

@bvreede bvreede merged commit 2b8e449 into main Oct 20, 2022
@bvreede bvreede deleted the update-docs-template branch October 20, 2022 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants