docs code block formatting

`console` type code-block is designed mainly for examples of the console commands with the output.

If it's just a shell script with comments, then `console` only gets in the way - e.g. if you try to select a console code block manually, you won't be able to select comment symbol `#` at the beginning of the command making code unrunnable if you try to copy and run it. I've replaced it with `bash` or `bat` (for Windows) code blocks where `console` wasn't necessary.

I've also removed `$` symbols at the beginning of the commands if it's not a `console` code-block - since otherwise it just breaks "Copy Code Block" because you copy unrunnable code.
This commit is contained in:
Andrej730
2024-06-21 18:28:52 +05:00
parent 746051815d
commit 4d39804045
15 changed files with 203 additions and 203 deletions
+12 -12
View File
@@ -88,10 +88,10 @@ aware of should be bolded, titlecased, and used consistently. You *may*
use italics to emphasize words or phrases. Inline code must be ``quoted`` and
longer code snippets may use code blocks.
.. code-block:: console
.. code-block:: bash
$ cd /path/to/blenderbim
$ ls
cd /path/to/blenderbim
ls
Be sure to specify the language to enable syntax highlighting.
@@ -149,19 +149,19 @@ 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:
.. code-block:: console
.. code-block:: bash
$ pip install furo
$ pip install sphinx-autoapi
$ pip install sphinx-copybutton
pip install furo
pip install sphinx-autoapi
pip install sphinx-copybutton
Now you can generate the documentation:
.. code-block:: console
.. code-block:: bash
$ cd /path/to/ifcopenshell/src/blenderbim/docs/
$ make html
$ cd _build/html
$ python -m http.server
cd /path/to/ifcopenshell/src/blenderbim/docs/
make html
cd _build/html
python -m http.server
You will now have a local webserver running hosting the documentation.