Skip to content

Commit

Permalink
Add :freeciv21: to the style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
lmoureaux committed Dec 30, 2024
1 parent 399cd5f commit 176e507
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/Contributing/style-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,13 +112,16 @@ to alter is placed inside back-ticks.
to it like this: :literal:`:ref:`My Anchor``. Notice that the anchor has an underscore at the beginning.
This is required for sphinx to recognize it. Also notice the use of the anchor in :literal:`:ref:` leaves
the underscore off.
* :literal:`:freeciv21:` -- Creates a reference to a C++ code entity or file documended using
Doxygen, powered by :external+intersphinx:doc:`Intersphinx <index>`.
* :literal:`:numref:` -- Create a cross-reference to a named figure.
* :literal:`:table:` -- Create a named table reference. Place an anchor (e.g. :literal:`.. _My Anchor:`) above
to enable :literal:`:numref:`.
* :literal:`:figure:` -- Create a named figure reference. Place an anchor (e.g. :literal:`.. _My Anchor:`)
above to enable :literal:`:numref:`.
* :literal:`:emphasis:` -- Emphasis is used to :emphasis:`bring attention to something`.
* :literal:`:file:` -- File is used for file names and paths such as :file:`~/.local/share/freeciv21/saves`.
For C++ source files, prefer ``:freeciv21:`` above.
* :literal:`:guilabel:` -- GUI Label is used to bring attention to something on the screen like the
:guilabel:`Next` button on the installer wizard.
* :literal:`:literal:` -- Literal is used when you want to note a text element in its raw form. This is
Expand Down
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,10 @@
# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
'intersphinx': ('https://sphinxcontrib-doxylink.readthedocs.io/en/stable/', None),
}

# -- Options for todo extension ----------------------------------------------

Expand Down

0 comments on commit 176e507

Please sign in to comment.