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: Update to use yaml files #545

Merged
merged 1 commit into from
Sep 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions doc-dev/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

formats:
- pdf
- epub

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build developer documentation in the doc-dev/ directory with Sphinx
sphinx:
configuration: doc-dev/rst/conf.py
#fail_on_warning: true

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: doc-dev/requirements.txt
6 changes: 3 additions & 3 deletions doc-dev/rst/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@
# built documents.
#
# The short X.Y version.
version = '1.2.0'
version = '3.0'
# The full version, including alpha/beta/rc tags.
release = '1.2.0'
release = '3.0.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -120,7 +120,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
#html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Expand Down
27 changes: 27 additions & 0 deletions doc/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

formats:
- pdf
- epub

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build user documentation in the doc/ directory with Sphinx
sphinx:
configuration: doc/rst/conf.py
#fail_on_warning: true

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: doc/requirements.txt
Comment on lines +25 to +27
Copy link
Member Author

@CamStan CamStan Sep 20, 2023

Choose a reason for hiding this comment

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

For future reference, the docutils version constraint we have in the requirements file might not be necessary anymore (this built in my test repo without it). I left it here as it still works, and we may want to use this file for reproducible builds in the future.

2 changes: 1 addition & 1 deletion doc/rst/users/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ Restart with a different number of processes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To restart an application with a different number of processes than used to save the checkpoint,
one must follow the steps listed in :ref:`scr-integration-restart-without`.
one must follow the steps listed in :ref:`sec-integration-restart-without`.
Additionally, one should set the following::

SCR_FLUSH_ON_RESTART=1
Expand Down