Skip to content

Swap to furo theme #79

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.

Sign up for GitHub

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

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Swap to furo theme #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dcc3306
Swap to furo theme
janbridley Sep 5, 2025
c27aa41
Reorder README badges based on color
janbridley Sep 5, 2025
e02f91e
Standardize sidebar headings
janbridley Sep 5, 2025
7f4b4da
Add umich block M
janbridley Sep 5, 2025
5ebf274
Swap bash blocks for sphinx console
janbridley Sep 5, 2025
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
2 changes: 1 addition & 1 deletion .github/workflows/environments/requirements-build.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file was autogenerated by uv via the following command:
# uv pip compile --python-version 3.13 --python-platform linux requirements-build.in
build==1.2.2.post1
build==1.3.0
# via -r requirements-build.in
packaging==25.0
# via build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/environments/requirements-doc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
sphinx
sphinx_rtd_theme
furo
37 changes: 23 additions & 14 deletions .github/workflows/environments/requirements-doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# This file was autogenerated by uv via the following command:
# uv pip compile --python-version 3.13 --python-platform linux requirements-doc.in
# uv pip compile --python-version 3.12 --python-platform linux requirements-doc.in
accessible-pygments==0.0.5
# via furo
alabaster==1.0.0
# via sphinx
babel==2.17.0
# via sphinx
certifi==2025.6.15
beautifulsoup4==4.13.5
# via furo
certifi==2025.8.3
# via requests
charset-normalizer==3.4.2
charset-normalizer==3.4.3
# via requests
docutils==0.21.2
# via
# sphinx
# sphinx-rtd-theme
# via sphinx
furo==2025.7.19
# via -r requirements-doc.in
idna==3.10
# via requests
imagesize==1.4.1
Expand All @@ -23,33 +27,38 @@ markupsafe==3.0.2
packaging==25.0
# via sphinx
pygments==2.19.2
# via sphinx
requests==2.32.4
# via
# accessible-pygments
# furo
# sphinx
requests==2.32.5
# via sphinx
roman-numerals-py==3.1.0
# via sphinx
snowballstemmer==3.0.1
# via sphinx
soupsieve==2.8
# via beautifulsoup4
sphinx==8.2.3
# via
# -r requirements-doc.in
# sphinx-rtd-theme
# sphinxcontrib-jquery
sphinx-rtd-theme==3.0.2
# via -r requirements-doc.in
# furo
# sphinx-basic-ng
sphinx-basic-ng==1.0.0b2
# via furo
sphinxcontrib-applehelp==2.0.0
# via sphinx
sphinxcontrib-devhelp==2.0.0
# via sphinx
sphinxcontrib-htmlhelp==2.1.0
# via sphinx
sphinxcontrib-jquery==4.1
# via sphinx-rtd-theme
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
typing-extensions==4.15.0
# via beautifulsoup4
urllib3==2.5.0
# via requests
14 changes: 9 additions & 5 deletions .github/workflows/environments/requirements-test-3.10.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
# This file was autogenerated by uv via the following command:
# uv pip compile --python-version 3.10 --python-platform linux requirements-test.in
exceptiongroup==1.2.2
exceptiongroup==1.3.0
# via pytest
iniconfig==2.1.0
# via pytest
numpy==2.2.5
numpy==2.2.6
# via
# -r requirements-test.in
# scipy
packaging==25.0
# via pytest
pluggy==1.5.0
pluggy==1.6.0
# via pytest
pytest==8.3.5
pygments==2.19.2
# via pytest
pytest==8.4.2
# via -r requirements-test.in
scipy==1.15.2
scipy==1.15.3
# via -r requirements-test.in
tomli==2.2.1
# via pytest
typing-extensions==4.15.0
# via exceptiongroup
10 changes: 6 additions & 4 deletions .github/workflows/environments/requirements-test-3.11.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@
# uv pip compile --python-version 3.11 --python-platform linux requirements-test.in
iniconfig==2.1.0
# via pytest
numpy==2.2.5
numpy==2.3.2
# via
# -r requirements-test.in
# scipy
packaging==25.0
# via pytest
pluggy==1.5.0
pluggy==1.6.0
# via pytest
pytest==8.3.5
pygments==2.19.2
# via pytest
pytest==8.4.2
# via -r requirements-test.in
scipy==1.15.2
scipy==1.16.1
# via -r requirements-test.in
10 changes: 6 additions & 4 deletions .github/workflows/environments/requirements-test-3.12.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@
# uv pip compile --python-version 3.12 --python-platform linux requirements-test.in
iniconfig==2.1.0
# via pytest
numpy==2.2.5
numpy==2.3.2
# via
# -r requirements-test.in
# scipy
packaging==25.0
# via pytest
pluggy==1.5.0
pluggy==1.6.0
# via pytest
pytest==8.3.5
pygments==2.19.2
# via pytest
pytest==8.4.2
# via -r requirements-test.in
scipy==1.15.2
scipy==1.16.1
# via -r requirements-test.in
10 changes: 6 additions & 4 deletions .github/workflows/environments/requirements-test-3.13.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@
# uv pip compile --python-version 3.13 --python-platform linux requirements-test.in
iniconfig==2.1.0
# via pytest
numpy==2.2.5
numpy==2.3.2
# via
# -r requirements-test.in
# scipy
packaging==25.0
# via pytest
pluggy==1.5.0
pluggy==1.6.0
# via pytest
pytest==8.3.5
pygments==2.19.2
# via pytest
pytest==8.4.2
# via -r requirements-test.in
scipy==1.15.2
scipy==1.16.1
# via -r requirements-test.in
10 changes: 7 additions & 3 deletions .github/workflows/environments/requirements-test-3.9.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file was autogenerated by uv via the following command:
# uv pip compile --python-version 3.9 --python-platform linux requirements-test.in
exceptiongroup==1.2.2
exceptiongroup==1.3.0
# via pytest
iniconfig==2.1.0
# via pytest
Expand All @@ -10,11 +10,15 @@ numpy==2.0.2
# scipy
packaging==25.0
# via pytest
pluggy==1.5.0
pluggy==1.6.0
# via pytest
pytest==8.3.5
pygments==2.19.2
# via pytest
pytest==8.4.2
# via -r requirements-test.in
scipy==1.13.1
# via -r requirements-test.in
tomli==2.2.1
# via pytest
typing-extensions==4.15.0
# via exceptiongroup
25 changes: 11 additions & 14 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,17 @@
rowan
=====

.. contents::
:local:

|ReadTheDocs|
|PyPI|
|conda-forge|
|ReadTheDocs|
|JOSS|

.. |ReadTheDocs| image:: https://readthedocs.org/projects/rowan/badge/?version=latest
:target: http://rowan.readthedocs.io/en/latest/?badge=latest
.. |PyPI| image:: https://img.shields.io/pypi/v/rowan.svg
:target: https://pypi.org/project/rowan/
.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/rowan.svg
:target: https://anaconda.org/conda-forge/rowan
.. |ReadTheDocs| image:: https://readthedocs.org/projects/rowan/badge/?version=latest
:target: http://rowan.readthedocs.io/en/latest/?badge=latest
.. |JOSS| image:: http://joss.theoj.org/papers/10.21105/joss.00787/status.svg
:target: https://doi.org/10.21105/joss.00787

Expand Down Expand Up @@ -49,26 +46,26 @@ Installation
The recommended methods for installing rowan are using **pip** or **conda**.
To install the package from PyPI, execute:

.. code-block:: bash
.. code-block:: console

$ pip install rowan

To install the package from conda, first add the **conda-forge** channel and
then install rowan:

.. code-block:: bash
.. code-block:: console

$ conda config --add channels conda-forge
$ conda install rowan


If you wish, you may also install rowan by cloning `the repository <https://github.com/glotzerlab/rowan>`_ and running the setup script:

.. code-block:: bash
.. code-block:: console

$ git clone https://github.com/glotzerlab/rowan.git
$ cd rowan
$ python setup.py install --user
$ pip install -e .

The minimum requirements for using rowan are:

Expand Down Expand Up @@ -112,7 +109,7 @@ Continuous integrated testing is performed using CircleCI on these Python versio

To run the packaged unit tests, execute the following line from the root of the repository:

.. code-block:: bash
.. code-block:: console

python -m unittest discover tests

Expand All @@ -130,13 +127,13 @@ You can also build this documentation from source if you clone the repository.
The documentation is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ and compiled using `Sphinx <http://www.sphinx-doc.org/en/master/>`_.
To build from source, first install Sphinx:

.. code-block:: bash
.. code-block:: console

pip install sphinx sphinx_rtd_theme
pip install sphinx furo

You can then use Sphinx to create the actual documentation in either PDF or HTML form by running the following commands in the rowan root directory:

.. code-block:: bash
.. code-block:: console

cd doc
make html # For html output
Expand Down
79 changes: 79 additions & 0 deletions doc/_static/umich-block-M.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading