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

docs: Fixed documentation build requirements #549

Merged
merged 4 commits into from
Oct 27, 2021
Merged

docs: Fixed documentation build requirements #549

merged 4 commits into from
Oct 27, 2021

Conversation

fg-mindee
Copy link
Contributor

@fg-mindee fg-mindee commented Oct 27, 2021

This PR fixes the documentation build job, by constraining the version of docutils. The release of yesterday (https://pypi.org/project/docutils/#history) is apparently either buggy or bringing breaking changes.

I also added some CI checks to ensure that at least the index.html (landing page) is correctly built!

Any feedback is welcome!

@fg-mindee fg-mindee added type: bug Something isn't working topic: documentation Improvements or additions to documentation critical High priority topic: ci Related to CI labels Oct 27, 2021
@fg-mindee fg-mindee added this to the 0.4.1 milestone Oct 27, 2021
@fg-mindee fg-mindee self-assigned this Oct 27, 2021
charlesmindee
charlesmindee previously approved these changes Oct 27, 2021
Copy link
Collaborator

@charlesmindee charlesmindee left a comment

Choose a reason for hiding this comment

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

Thanks for the fix!

@codecov
Copy link

codecov bot commented Oct 27, 2021

Codecov Report

Merging #549 (e1fa1d5) into main (ec0dcfb) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #549   +/-   ##
=======================================
  Coverage   95.98%   95.98%           
=======================================
  Files         109      109           
  Lines        4180     4180           
=======================================
  Hits         4012     4012           
  Misses        168      168           
Flag Coverage Δ
unittests 95.98% <ø> (ø)

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 ec0dcfb...e1fa1d5. Read the comment docs.

Copy link
Collaborator

@charlesmindee charlesmindee left a comment

Choose a reason for hiding this comment

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

Thanks!

@fg-mindee fg-mindee merged commit c356d9e into main Oct 27, 2021
@fg-mindee fg-mindee deleted the doc-fix branch October 27, 2021 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
critical High priority topic: ci Related to CI topic: documentation Improvements or additions to documentation type: bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants