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

Use sphinx_rtd_theme #645

Merged
merged 13 commits into from
Oct 27, 2023
4 changes: 2 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

version: 2

formats: all
formats: [htmlzip]

python:
system_packages: true
Copy link
Contributor

Choose a reason for hiding this comment

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

should be removed - this option is deprecated (similar to radical-cybertools/radical.pilot#3029)

version: 3.6
version: 3.7
install:
- requirements: requirements-docs.txt
- method: pip
Expand Down
11 changes: 8 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinxcontrib.napoleon',
'nbsphinx',
'sphinx_copybutton',
'sphinx_rtd_theme',
'sphinx.ext.napoleon',
'sphinx.ext.imgconverter',
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -72,15 +76,16 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# exclude_patterns = []


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "armstrong"
# html_theme = "armstrong"
html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]

# Add any paths that contain custom static files (such as style sheets) here,
Expand Down
27 changes: 13 additions & 14 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
RADICAL-Ensemble Toolkit
========================

The Ensemble Toolkit is a Python library for developing and executing
large-scale ensemble-based workflows. It is being developed by the
`RADICAL Research Group <http://radical.rutgers.edu/>`_ at Rutgers University.
Ensemble Toolkit is released under the
`MIT License <http://opensource.org/licenses/MIT>`_.
The Ensemble Toolkit is a Python library for developing and executing
large-scale ensemble-based workflows. It is being developed by the
`RADICAL Research Group <http://radical.rutgers.edu/>`_ at Rutgers University.
Ensemble Toolkit is released under the
`MIT License <http://opensource.org/licenses/MIT>`_.

More details about the science enabled by EnTK can be found in the following publications:

Expand All @@ -21,9 +21,9 @@ More details about the science enabled by EnTK can be found in the following pub

.. note:: Please use the following to reference Ensemble Toolkit

Balasubramanian, Vivekanandan, Antons Treikalis, Ole Weidner, and Shantenu
Jha. "Ensemble toolkit: Scalable and flexible execution of ensembles of
tasks." In Parallel Processing (ICPP), 2016 45th International Conference
Balasubramanian, Vivekanandan, Antons Treikalis, Ole Weidner, and Shantenu
Jha. "Ensemble toolkit: Scalable and flexible execution of ensembles of
tasks." In Parallel Processing (ICPP), 2016 45th International Conference
on, pp. 458-463. IEEE, 2016.


Expand Down Expand Up @@ -58,7 +58,6 @@ More details about the science enabled by EnTK can be found in the following pub

.. toctree::
:maxdepth: 2
:numbered:
:caption: Contents:

introduction
Expand All @@ -71,9 +70,9 @@ More details about the science enabled by EnTK can be found in the following pub
exceptions
dev_docs

Indices and tables
==================
.. Indices and tables
.. ==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
10 changes: 8 additions & 2 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@

-r requirements.txt

sphinx>=5.1
sphinxcontrib-napoleon
sphinx==5.3.0
ipython
ipykernel
nbsphinx==0.8.12
python-dotenv[cli]
sphinx_copybutton
sphinx_rtd_theme>=0.5.1
docutils==0.17.1