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

#408 Fix Read the docs build. #409

Merged
merged 3 commits into from
Aug 31, 2022
Merged

#408 Fix Read the docs build. #409

merged 3 commits into from
Aug 31, 2022

Conversation

adiroiban
Copy link
Member

Description

The build on RTD for trunk fails due to missing version in docs/conf.py

Changes

The version was previously removed as it was a static version.
It was not replaced with the real version.

The copyright was also updated to include the version and build time.

The RTD was updated not to generate PDF and EPUB.

@adiroiban adiroiban requested a review from a team as a code owner August 30, 2022 13:18
@codecov
Copy link

codecov bot commented Aug 30, 2022

Codecov Report

Merging #409 (679d843) into trunk (dd47c1f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            trunk     #409   +/-   ##
=======================================
  Coverage   97.85%   97.85%           
=======================================
  Files          22       22           
  Lines        1400     1400           
  Branches      130      124    -6     
=======================================
  Hits         1370     1370           
  Misses         15       15           
  Partials       15       15           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated
project = "Towncrier"
copyright = "2017, Amber Brown"
copyright = "{}, Towncrier contibutors. Ver {}. Built on {}".format(
Copy link
Member

Choose a reason for hiding this comment

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

Typo in "contributors" here.

@hynek hynek enabled auto-merge August 31, 2022 04:40
@hynek hynek merged commit 1590753 into trunk Aug 31, 2022
@hynek hynek deleted the 408-rtd-build-fix branch August 31, 2022 04:40
@adiroiban
Copy link
Member Author

Thanks for your reviews.

I think we are in good shape.

Happy to see the dev docs available as part of the Read The Docs build.
it should make it easier to read and review the content in the future.

@hynek
Copy link
Member

hynek commented Aug 31, 2022

This is a good moment to switch the default to "stable" instead of "latest"?

@adiroiban
Copy link
Member Author

Done. Thanks for the headup.

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.

3 participants