Skip to content

Commit

Permalink
documentation/README.rst: fix URL and git command (#1574)
Browse files Browse the repository at this point in the history
  • Loading branch information
cgay authored Mar 22, 2024
2 parents 55d3fe3 + c6d897b commit c33942a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions documentation/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Before building this documentation, you will need a copy of Sphinx
installed. The latest versions of Sphinx use Python 3 so we assume Python 3 is
in use here. The easiest way to install Sphinx is to get it from the `Python
Package Index <http://pypi.python.org/pypi/Sphinx>`_ or to use ``pip3``::

sudo pip3 install -U Sphinx

On some systems it might be called just ``pip`` even when installing Python 3
Expand All @@ -20,7 +20,7 @@ You also need to have the git submodule for our Sphinx extension populated. If
this is not present for you, do this at the top level of the opendylan
repository::

git submodule init && git submodule update
git submodule update --init --recursive

Building
========
Expand Down Expand Up @@ -57,7 +57,7 @@ least on Debian) to install these packages:
* texlive-latex-recommended
* texlive-fonts-recommended
* texlive-latex-extra


Link Validation
---------------
Expand All @@ -72,9 +72,9 @@ Section Header Markup
=====================

We are following the `Sphinx suggestions
<http://sphinx.pocoo.org/rest.html#sections>`_ for header markup, which
are as follows:
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections>`_
for header markup, which are as follows:

* # with overline, for parts
* \* with overline, for chapters
* =, for sections
Expand Down

0 comments on commit c33942a

Please sign in to comment.