mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-09 17:31:45 +00:00
Even more cleaning of documentation references
This commit is contained in:
@@ -17,8 +17,8 @@
|
||||
{% block subpackages %}
|
||||
{% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
|
||||
{% if visible_subpackages %}
|
||||
Subpackagesa
|
||||
------------
|
||||
Subpackages
|
||||
-----------
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:maxdepth: 1
|
||||
|
||||
+22
-4
@@ -51,14 +51,32 @@ section img {
|
||||
box-shadow: rgba(0, 0, 0, 0.24) 0px 3px 8px;
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
/* Make it clearer which signatures are part of a class */
|
||||
.py.class {
|
||||
/* Make it clearer which signatures are part of a class */
|
||||
border-left: 3px solid var(--color-brand-primary);
|
||||
}
|
||||
.py.function, .py.method {
|
||||
/* Make it clearer which signatures are part of a method or function */
|
||||
border-left: 3px solid var(--color-background-item);
|
||||
.py.class > .sig {
|
||||
background: var(--color-brand-primary) !important;
|
||||
margin: 0;
|
||||
border-radius: 0;
|
||||
}
|
||||
.py.class > .sig * {
|
||||
color: #2e3436 !important;
|
||||
}
|
||||
.py.class > .sig a {
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
/* Make it easier to spot functions and methods */
|
||||
.py.function, .py.method {
|
||||
border-top: 1px solid var(--color-background-item);
|
||||
}
|
||||
dl.py.property, dl.py.attribute, dl.py.method, dl.py.function {
|
||||
padding-top: 10px;
|
||||
padding-bottom: 10px;
|
||||
}
|
||||
|
||||
.field-list > dt {
|
||||
/* Clearly distinguish parameters otherwise it looks like a wall of text */
|
||||
color: var(--color-brand-content);
|
||||
|
||||
@@ -21,14 +21,15 @@ Python API documentation is autogenerated from docstrings present in the source
|
||||
code of the respective Python module.
|
||||
|
||||
If you want to build the documentation locally, the documentation system uses
|
||||
`Sphinx <https://www.sphinx-doc.org/en/master/>`_. First, install the theme and
|
||||
theme dependencies:
|
||||
`Sphinx <https://www.sphinx-doc.org/en/master/>`_. First, install Sphinx and
|
||||
dependencies:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install furo
|
||||
$ pip install sphinx
|
||||
$ pip install sphinx-autoapi
|
||||
$ pip install sphinx-copybutton
|
||||
$ pip install furo
|
||||
|
||||
Now you can generate the documentation:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user