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

feat: add readthedocs config #303

Merged
merged 5 commits into from
Apr 27, 2023
Merged

Conversation

rgraber
Copy link
Contributor

@rgraber rgraber commented Apr 27, 2023

Description:

Adds a readthedocs.yaml file to allow us to configure the readthedocs settings in the GH repo. In particular, sets the python version to 3.8 (default on readthedocs is 3.7, which is incompatible with some of the required packages).

Also adds a long_description_content_type to get rid of a warning. There are still a lot of autodoc warnings, and fixing them all will take a while. I set fail_on_warning to false for now since I do not think this should be held up on fixing all the autodoc warnings.

Issue:

#301

Dependencies:

List dependencies on other outstanding PRs, issues, etc.

Reviewers:

  • tag reviewer

Merge checklist:

  • All reviewers approved
  • CI build is green
  • [ N/A ] Version bumped
  • [ N/A ] Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • [ N/A ] Create a tag
  • Check new version is pushed to PyPi after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
fail_on_warning: true
Copy link
Contributor

Choose a reason for hiding this comment

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

You might need to make docs locally and ensure there are no warnings.

@rgraber rgraber marked this pull request as ready for review April 27, 2023 18:15
@rgraber rgraber merged commit 20040dc into master Apr 27, 2023
@rgraber rgraber deleted the rsgraber/20230427-docs-build-38 branch April 27, 2023 18:24
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