Skip to content

Commit

Permalink
Minor fix to sphinx docs
Browse files Browse the repository at this point in the history
Use anonymous reference for GNATS web link so that it doesn't conflict
with name of internal link.  See
sphinx-doc/sphinx#3921.
  • Loading branch information
jmcfarland-swri committed May 8, 2020
1 parent 14c659b commit a6d0a22
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/src/gnats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ GNATS simulation

.. py:module:: paraatm.io.gnats
`para-atm` includes capabilities to facilitate running the `GNATS <https://github.com/OptimalSynthesisInc/GNATS>`_ simulation from within Python. These capabilities are provided by the :py:mod:`paraatm.io.gnats` module. The following functionality is provided:
`para-atm` includes capabilities to facilitate running the `GNATS <https://github.com/OptimalSynthesisInc/GNATS>`__ simulation from within Python. These capabilities are provided by the :py:mod:`paraatm.io.gnats` module. The following functionality is provided:

* Boilerplate code to automatically start and stop the Java virtual machine, and to prevent it from being started multiple times
* Behind-the-scenes path handling, so that the GNATS simulation does not need to be run from within the GNATS installation directory
Expand Down

0 comments on commit a6d0a22

Please sign in to comment.