Skip to content

Commit

Permalink
Bump sphinx,docutils version
Browse files Browse the repository at this point in the history
- Github CI now fails otherwise
- Also update broken links to LIBRA docs
  • Loading branch information
jharwell committed Feb 1, 2024
1 parent 94f9158 commit 9653bb8
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 21 deletions.
1 change: 1 addition & 0 deletions .github/actions/publish/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ runs:
shell: bash
run: |
python3 -m build
cd docs && make linkcheck
- name: Set tag
if: github.ref == 'refs/heads/devel'
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/sierra-setup/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ runs:
- name: Install SIERRA
shell: bash
run: |
python -m pip install -r docs/requirements.txt
python3 -m pip install -r docs/requirements.txt
cd docs && make man && cd ..
python3 -m pip install .
python3 -m pip install .[devel]
Expand Down
10 changes: 5 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,10 @@
"https://www.cs.unm.edu/~wjust/CS523/S2018/Readings/Hecker_Beyond_Pheromones_Swarm_Intelligence.pdf"),
"Rosenfeld2006": ("Rosenfeld2006",
"http://users.umiacs.umd.edu/~sarit/data/articles/rosenfeldetalbook06.pdf"),
"SIERRA_GITHUB": ("https://github.com:jharwell/sierra.git",
"https://github.com:jharwell/sierra.git"),
"SIERRA_SAMPLE_PROJECT": ("https://github.com:jharwell/sierra-sample-project.git",
"https://github.com:jharwell/sierra-sample-project.git"),
"SIERRA_GITHUB": ("https://github.com/jharwell/sierra.git",
"https://github.com/jharwell/sierra.git"),
"SIERRA_SAMPLE_PROJECT": ("https://github.com/jharwell/sierra-sample-project.git",
"https://github.com/jharwell/sierra-sample-project.git"),
"SIERRA_DOCS": ("https://sierra.readthedocs.io/en/master",
"https://sierra.readthedocs.io/en/master"),
"FORDYCA": ("FORDYCA", "https://swarm-robotics-fordyca.readthedocs.io"),
Expand Down Expand Up @@ -310,7 +310,7 @@
'sphinx': ('https://www.sphinx-doc.org/en/stable/', None),
'pandas': ('https://pandas.pydata.org/pandas-docs/dev', None),
'implements': ('https://implements.readthedocs.io/en/latest/', None),
'libra': ('https://libra2.readthedocs.io/en/master', None)
'libra': ('https://jharwell.github.io/libra', None)
}

# This is the expected signature of the handler for this event, cf doc
Expand Down
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
-e .

sphinx==4.4.0
docutils==0.16
sphinx==5.0.2
docutils==0.18.1
sphinx-rtd-theme
sphinx-argparse
sphinx-tabs
Expand Down
4 changes: 2 additions & 2 deletions docs/src/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Writing the code
----------------

To contribute to the SIERRA core, in you should follow the general workflow and
python development guide outlined in :ref:`ln-libra-python-dev-guide` and
:ref:`ln-libra-dev-workflow`. For the static analysis step:
python development guide outlined in :ref:`libra:dev/python-guide` and
:ref:`libra:dev/workflow`. For the static analysis step:

#. Install development packages for SIERRA (from the SIERRA repo root)::

Expand Down
11 changes: 5 additions & 6 deletions docs/src/matrix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ see the :ref:`ln-sierra-tutorials` for how to add it via a plugin.
- Simulator for fast simulation of large swarms. Requires ARGoS >=
3.0.0-beta59.

* - `ROS1 <https://ros.org)+[Gazebo](https://www.gazebosim.org>`_
* - `ROS1 <https://ros.org>`_ + `Gazebo <https://www.gazebosim.org/home>`_

- Using ROS1 with the Gazebo simulator. Requires Gazebo >= 11.9.0, ROS1
Noetic or later.
Expand Down Expand Up @@ -84,7 +84,7 @@ listed, see the :ref:`ln-sierra-tutorials` for how to add it via a plugin.
- Simulator for fast simulation of large swarms. Requires ARGoS >=
3.0.0-beta59.

* - `ROS1 <https://ros.org)+[Gazebo](https://www.gazebosim.org>`_
* - `ROS1 <https://ros.org>`_ + `Gazebo <https://www.gazebosim.org/home>`_

- Using ROS1 with the Gazebo simulator. Requires Gazebo >= 11.9.0, ROS1
Kinetic or later.
Expand All @@ -95,10 +95,9 @@ listed, see the :ref:`ln-sierra-tutorials` for how to add it via a plugin.
later is required.

SIERRA also supports multiple output formats for experimental outputs. If the
format for your experimental outputs is not listed, see the `docs
<https://sierra.readthedocs.io/en/master/src/tutorials.html>`_
for how to add it via a plugin. SIERRA currently only supports XML experimental
inputs.
format for your experimental outputs is not listed, see the
:ref:`ln-sierra-tutorials` for how to add it via a plugin. SIERRA currently only
supports XML experimental inputs.

.. list-table::
:header-rows: 1
Expand Down
4 changes: 2 additions & 2 deletions docs/src/trial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ you clone things somewhere else.

Where ``<distro>`` is replaced by your ROS distro.

#. Install the `SIERRA ROSBridge <https:github.com/jharwell/sierra_rosbridge.git>`_::
#. Install the `SIERRA ROSBridge <https://github.com/jharwell/sierra_rosbridge.git>`_::

pip3 install catkin_tools
git clone https://github.com/jharwell/sierra_rosbridge.git
Expand Down Expand Up @@ -134,7 +134,7 @@ you clone things somewhere else.
.. group-tab:: ROS1+Gazebo

Based on one of the turtlebot3 `intro tutorials
<https://github.com:ROBOTIS-GIT/turtlebot3_simulations.git>`_::
<https://github.com/ROBOTIS-GIT/turtlebot3_simulations.git>`_::

git clone https://github.com/jharwell/sierra-sample-project.git
cd sierra-sample-project/ros1gazebo
Expand Down
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,13 @@
'setuptools',

# Sphinx packages
"sphinx==4.4.0",
"docutils==0.16",
"sphinx==5.0.2",
"docutils==0.18.1",
"sphinx-rtd-theme",
"sphinx-argparse",
"sphinx-tabs",
"sphinxcontrib-napoleon",
"psutil",
"sphinx-last-updated-by-git",
"autoapi",
"graphviz"
Expand Down
2 changes: 1 addition & 1 deletion sierra/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@

# Project packages

__version__ = "1.3.5"
__version__ = "1.3.6"

0 comments on commit 9653bb8

Please sign in to comment.