Sphinx Tips¶

Cheat-sheet¶

Insert an image¶

Sample syntax:

.. image:: vuejs_tips_resources/Vue_project_creation.PNG
   :scale: 40%

Launch a build¶

To build the documentation, use this command:

aleja@CC-Labs-2 MINGW64 ~/Documents/Code/consulting/CCL_Finastra/project/documentation (EAA_PCL)
$ sphinx-build -b html source build
Running Sphinx v2.3.1
****** Setting EA_ANALYST_HOME = "C:\Users\aleja\Documents\Code\consulting\CCL_Finastra".
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
no targets are out of date.
build succeeded.

The HTML pages are in build.
(base)
aleja@CC-Labs-2 MINGW64 ~/Documents/Code/consulting/CCL_Finastra/project/documentation (EAA_PCL)
$ ls
__init__.py  build/  documentation_code_snippets/  make.bat  Makefile  resources/  source/  sphinx_extensions/

Render a bash shell¶

To display some commands on a bash shell, use .. code-block:: bash, as in this example.

You write this in your RST file:

.. code-block:: bash

    aleja@CC-Labs-2 MINGW64 ~/Documents/Code/chateauclaudia-labs/lab-notebooks
    $ ls -lsa .
    total 17
    4 drwxr-xr-x 1 aleja 197609  0 May 10 15:35 ./
    4 drwxr-xr-x 1 aleja 197609  0 May 10 15:06 ../
    4 drwxr-xr-x 1 aleja 197609  0 May 13 13:12 build/
    1 -rw-r--r-- 1 aleja 197609 60 May 10 15:09 lab-notebooks.code-workspace
    4 drwxr-xr-x 1 aleja 197609  0 May 10 15:37 resources/
    0 drwxr-xr-x 1 aleja 197609  0 May 10 15:15 source/

That would be rendered as follows:

aleja@CC-Labs-2 MINGW64 ~/Documents/Code/chateauclaudia-labs/lab-notebooks
$ ls -lsa .
total 17
4 drwxr-xr-x 1 aleja 197609  0 May 10 15:35 ./
4 drwxr-xr-x 1 aleja 197609  0 May 10 15:06 ../
4 drwxr-xr-x 1 aleja 197609  0 May 13 13:12 build/
1 -rw-r--r-- 1 aleja 197609 60 May 10 15:09 lab-notebooks.code-workspace
4 drwxr-xr-x 1 aleja 197609  0 May 10 15:37 resources/
0 drwxr-xr-x 1 aleja 197609  0 May 10 15:15 source/

GIT Tips Python Packaging Tips