Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-19 03:33:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enable Sphinx auto section labels. Minor doc link fix.

Browse Source
This commit is contained in:
Dion Moult
2023-09-08 12:06:47 +10:00
parent 073491a78a
commit 5edc6c4d8a
4 changed files with 19 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/blenderbim/docs/devs/writing_docs.rst
+7 -4
View File
@@ -13,10 +13,13 @@ All documentation is written in ReStructured Text and is available in the
`BlenderBIM Add-on docs directory
<https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.7.0/src/blenderbim/docs>`_.
You can link to `external websites <https://ifcopenshell.org>`_. You can also
link to sections on the same page, like `Writing technical documentation`_.
:doc:`Code examples<code_examples>`
You can link to `external websites
<https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html>`_.
You can also link to sections on the same page, like `Writing technical
documentation`_. You can link to other pages, like :doc:`Hello
World<hello_world>` or sections within other pages, like
:ref:`devs/installation:unstable installation`. We have ``autosectionlabel``
enabled so it is not necessary to manually create labels.
The following colours and annotation styles should be used for annotating
images. All stroke widths are 3px with a corner radius of 3px. Horizontal