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

readthedocs build fix #528

Merged
merged 7 commits into from
Aug 8, 2023
Merged

readthedocs build fix #528

merged 7 commits into from
Aug 8, 2023

Conversation

hkershaw-brown
Copy link
Member

Description:

  • Added an explicit target for the welcome page (index.rst). The links to README.rst were relative using the filename, so had to be updated for the rename to index.rst.
  • Using root_doc instead of master_doc to follow latest sphinx conf.py guidance
  • explicit conf.py following readthedocs v2 configuration

Fixes issue

fixes #526

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Documentation changes needed?

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.

Tests

Tested the build on readthedocs:
fix-doc-index branch build: https://readthedocs.org/projects/dart-documentation/builds/21507857/

Checklist for merging

  • Updated changelog entry
  • Documentation updated
  • Update conf.py

Checklist for release

  • Merge into main
  • Create release from the main branch with appropriate tag
  • Delete feature-branch

Testing Datasets

  • Dataset needed for testing available upon request
  • Dataset download instructions included
  • No dataset needed

hkershaw-brown and others added 4 commits August 3, 2023 15:24
…on5+ constants

mpas updated the constants in v5: MPAS-Dev/MPAS-Model@d2b19b6
theta_m and pressure use rvord (=1.608362) instead of 1.61
This fix is consistant with the latest version of MPAS: v8.0.1

fixes #251

Co-authored-by: syha <syha@ucar.edu>
Co-authored-by: syha <syha@ucar.edu>
fixes #526

Added an explicit target for the welcome page (index.rst). The links to
README.rst were relative using the filename, so had to be udated for the
rename to index.rst.
Using root_doc instead of master_doc to follow latest sphinx conf.py guidence
explicit conf.py following readthedocs v2 configuration
@mjs2369
Copy link
Contributor

mjs2369 commented Aug 7, 2023

@hkershaw-brown everything looks great. I added some suggested changes to make the references to the Welcome page consistent (using "Getting Started" as the name), but feel free to ignore them.

I went through the docs to make sure all the references were working, and they are. So this is ready to merge into main once you either approve/reject the suggested changes, and then I'll approve the PR immediately afterwards

@hkershaw-brown
Copy link
Member Author

@mjs2369 I can't see your suggestions.

Do you want to change the name of the label:
.. _Welcome page: to .._Getting Started

Copy link
Contributor

@mjs2369 mjs2369 left a comment

Choose a reason for hiding this comment

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

@hkershaw-brown this should reveal my suggestions, sorry about that

models/wrf/tutorial/README.rst Outdated Show resolved Hide resolved
models/wrf/tutorial/README.rst Outdated Show resolved Hide resolved
models/wrf/tutorial/README.rst Show resolved Hide resolved
models/clm/tutorial/README.rst Show resolved Hide resolved
removed the unnecessary 'the'
getting started is capitalized in the rest of the document.

Co-authored-by: Marlena Smith <44214771+mjs2369@users.noreply.github.com>
hkershaw-brown and others added 2 commits August 8, 2023 09:17
mpas_atm model_mod constants updated to match version 5+ of MPAS
@hkershaw-brown hkershaw-brown merged commit 9729d78 into main Aug 8, 2023
2 checks passed
@hkershaw-brown hkershaw-brown deleted the fix-doc-index branch August 14, 2023 12:56
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 build failing due to no index.html generated
2 participants