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

Add config file for building docs on RTD #74

Merged
merged 3 commits into from
Aug 22, 2023
Merged

Add config file for building docs on RTD #74

merged 3 commits into from
Aug 22, 2023

Conversation

eirikurj
Copy link
Contributor

@eirikurj eirikurj commented Jun 9, 2023

Purpose

ReadTheDocs will soon require a config file for build the docs. This PR addresses that.

Expected time until merged

Whenever docs build pass

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@eirikurj eirikurj requested a review from a team as a code owner June 9, 2023 16:36
@eirikurj eirikurj requested review from lamkina and sseraj June 9, 2023 16:36
@codecov
Copy link

codecov bot commented Jun 9, 2023

Codecov Report

Merging #74 (5aa4a94) into main (9f9a130) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #74   +/-   ##
=======================================
  Coverage   79.48%   79.48%           
=======================================
  Files           4        4           
  Lines         424      424           
=======================================
  Hits          337      337           
  Misses         87       87           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@lamkina lamkina merged commit c115596 into main Aug 22, 2023
11 checks passed
@sseraj sseraj deleted the addRTDConf branch August 22, 2023 15:21
DavidAnderegg pushed a commit to anilyil/pyhyp that referenced this pull request Sep 3, 2024
* add config file for building docs

* add newline

---------

Co-authored-by: Marco Mangano <36549388+marcomangano@users.noreply.github.com>
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.

4 participants