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

Read The Docs update #86

Merged
merged 7 commits into from Aug 17, 2023
Merged

Read The Docs update #86

merged 7 commits into from Aug 17, 2023

Conversation

aburrell
Copy link
Owner

@aburrell aburrell commented Aug 17, 2023

Description

Updated the RTD support, which now requires a yaml file for configuration.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

Tests using RTD webhook.

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to Changelog.rst, summarising the changes
  • Add yourself to AUTHORS.rst and .zenodo.json

Added a RTD yaml file at the default location.
Moved all the doc requirements to the pyproject.toml file.
Added a summary of the changes to the changelog.
@aburrell aburrell added this to the v2.7.0 milestone Aug 17, 2023
@coveralls
Copy link

coveralls commented Aug 17, 2023

Pull Request Test Coverage Report for Build 5891309527

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.2%) to 92.815%

Totals Coverage Status
Change from base Build 4125905438: 0.2%
Covered Lines: 1155
Relevant Lines: 1232

💛 - Coveralls

Fixed a bug where the old requirements file was used in the docs test.  Updated main test to import test requirements from pyproject.toml.
Updated call to napoleon sphinx extension.
Removed an extra period, introduced as a typo.
Added a version limit for the sphinx RTD theme.
@aburrell aburrell merged commit e8d5bd9 into develop Aug 17, 2023
31 checks passed
@aburrell aburrell deleted the rtd_update branch August 17, 2023 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants