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

Use "Material for Sphinx" theme for documentation #154

Merged
merged 1 commit into from
Sep 15, 2020

Conversation

amotl
Copy link
Member

@amotl amotl commented Sep 15, 2020

This switches to Material for Sphinx, which provides a more modern documentation look & feel. Also, it renders tremendously better on mobile devices.

@amotl amotl requested a review from gutzbenj September 15, 2020 07:14
@codecov
Copy link

codecov bot commented Sep 15, 2020

Codecov Report

Merging #154 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #154   +/-   ##
=======================================
  Coverage   91.85%   91.85%           
=======================================
  Files          28       28           
  Lines        1436     1436           
  Branches      103      103           
=======================================
  Hits         1319     1319           
  Misses         88       88           
  Partials       29       29           
Flag Coverage Δ
#unittests 91.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


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 a12dfb9...016dd42. Read the comment docs.

@amotl amotl force-pushed the sphinx-material branch 2 times, most recently from a350471 to c8d28aa Compare September 15, 2020 07:38
@amotl amotl merged commit fea8648 into earthobservations:master Sep 15, 2020
@amotl
Copy link
Member Author

amotl commented Sep 15, 2020

Might RTD has got stuck after merging this?

@gutzbenj
Copy link
Member

gutzbenj commented Sep 15, 2020

This is the output

Collecting sphinx_rtd_theme==0.5.0
  Downloading sphinx_rtd_theme-0.5.0-py2.py3-none-any.whl (10.8 MB)
ERROR: Could not find a version that satisfies the requirement sphinx-material=="0.0.30" (from -r docs/requirements.txt (line 2)) (from versions: 0.0.3, 0.0.4, 0.0.5, 0.0.6, 0.0.7, 0.0.8, 0.0.9, 0.0.10, 0.0.11, 0.0.12, 0.0.13, 0.0.14, 0.0.15, 0.0.16, 0.0.17, 0.0.18, 0.0.19, 0.0.20, 0.0.21, 0.0.22, 0.0.23, 0.0.24, 0.0.25, 0.0.26, 0.0.27, 0.0.28, 0.0.29, 0.0.30)
ERROR: No matching distribution found for sphinx-material=="0.0.30" (from -r docs/requirements.txt (line 2))

@gutzbenj
Copy link
Member

It should be sphinx-material==0.0.30

@amotl
Copy link
Member Author

amotl commented Sep 15, 2020

Thanks. I've just fixed it.

@amotl amotl deleted the sphinx-material branch September 23, 2020 00:31
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