mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-11 02:02:22 +00:00
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:
@@ -17,7 +17,7 @@ Source installation
|
||||
Here is a minimal example of how to use IfcPatch as a Python module or CLI
|
||||
utility:
|
||||
|
||||
::
|
||||
.. code-block:: console
|
||||
|
||||
$ python -m ifcclash -h
|
||||
|
||||
@@ -77,10 +77,10 @@ defined with data sources.
|
||||
Once your have your JSON description of your clashes, usage is like any other
|
||||
CLI app.
|
||||
|
||||
::
|
||||
.. code-block:: bash
|
||||
|
||||
$ ifcclash clash_sets.json
|
||||
$ cat output.json
|
||||
ifcclash clash_sets.json
|
||||
cat output.json
|
||||
|
||||
Here is a minimal example of how to use IfcClash as a library:
|
||||
|
||||
@@ -106,13 +106,13 @@ Here is a minimal example of how to use IfcClash as a library:
|
||||
|
||||
You can also alias it to a command:
|
||||
|
||||
::
|
||||
.. code-block:: bash
|
||||
|
||||
$ alias ifcclash='python -m ifcclash'
|
||||
alias ifcclash='python -m ifcclash'
|
||||
|
||||
Alternatively, you can package it as an executable.
|
||||
|
||||
::
|
||||
|
||||
$ python make.py
|
||||
$ ./dist/ifcclash
|
||||
python make.py
|
||||
./dist/ifcclash
|
||||
|
||||
Reference in New Issue
Block a user