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 #156

Merged
merged 4 commits into from
Aug 24, 2023
Merged

Docs #156

merged 4 commits into from
Aug 24, 2023

Conversation

AntObi
Copy link
Collaborator

@AntObi AntObi commented Aug 24, 2023

Reproducible docs build

Description

  • Updated .readthedocs.yaml
  • Updated requirements.txt using pip-tools
  • Created docs/requirements.txt and docs/requirements.in for reproducible building of the documentation

Fixes #155

Type of change

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

  • Verified that the documentation could be built in a new environment using the packages in docs/requirements.txt

Test Configuration:

  • Python version: 3.9
  • Operating System: WSL2

Reviewers

N/A

Checklist:

  • 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
  • I have checked my code and corrected any misspellings

@codecov
Copy link

codecov bot commented Aug 24, 2023

Codecov Report

Merging #156 (6eccdf2) into master (a6005bd) will not change coverage.
Report is 5 commits behind head on master.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #156   +/-   ##
=======================================
  Coverage   72.89%   72.89%           
=======================================
  Files          24       24           
  Lines        1896     1896           
=======================================
  Hits         1382     1382           
  Misses        514      514           

@AntObi AntObi merged commit 1d13007 into master Aug 24, 2023
12 checks passed
@AntObi AntObi deleted the docs branch August 24, 2023 14:44
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.

Readthedocs is deprecating the "use system packages" feature
1 participant