diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2021-12-13 07:15:58 +0300 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2021-12-13 08:20:37 +0300 |
commit | dd27e35e4cb31e7f3c2d42d74f7e877bb72e8318 (patch) | |
tree | 9c05c7231e758385e9a40fbe07c3720d7110e6c0 /doc | |
parent | 20732a3665e1768958e874e54ff77a1a5bca2976 (diff) |
doc: Use "console" for the highlight language of console output
Using "console" language is better for the console example (including
command-line prompt)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/theming.rst | 4 | ||||
-rw-r--r-- | doc/man/sphinx-autogen.rst | 2 | ||||
-rw-r--r-- | doc/usage/advanced/setuptools.rst | 14 | ||||
-rw-r--r-- | doc/usage/installation.rst | 4 | ||||
-rw-r--r-- | doc/usage/quickstart.rst | 6 | ||||
-rw-r--r-- | doc/usage/theming.rst | 2 |
6 files changed, 16 insertions, 16 deletions
diff --git a/doc/development/theming.rst b/doc/development/theming.rst index a63a1d668..08cd37121 100644 --- a/doc/development/theming.rst +++ b/doc/development/theming.rst @@ -285,7 +285,7 @@ engine, allowing you to embed variables and control behavior. For example, the following JavaScript structure: -.. code-block:: bash +.. code-block:: none mymodule/ ├── _static @@ -294,7 +294,7 @@ For example, the following JavaScript structure: Will result in the following static file placed in your HTML's build output: -.. code-block:: bash +.. code-block:: none _build/ └── html diff --git a/doc/man/sphinx-autogen.rst b/doc/man/sphinx-autogen.rst index 4c8f0f207..cad22bf22 100644 --- a/doc/man/sphinx-autogen.rst +++ b/doc/man/sphinx-autogen.rst @@ -75,7 +75,7 @@ and assuming ``docs/index.rst`` contained the following: If you run the following: -.. code-block:: bash +.. code-block:: console $ PYTHONPATH=. sphinx-autogen docs/index.rst diff --git a/doc/usage/advanced/setuptools.rst b/doc/usage/advanced/setuptools.rst index 7f993e10c..c6ef0fb41 100644 --- a/doc/usage/advanced/setuptools.rst +++ b/doc/usage/advanced/setuptools.rst @@ -64,7 +64,7 @@ Options for setuptools integration This can also be set by passing the `-E` flag to ``setup.py``: - .. code-block:: bash + .. code-block:: console $ python setup.py build_sphinx -E @@ -75,7 +75,7 @@ Options for setuptools integration This can also be set by passing the `-a` flag to ``setup.py``: - .. code-block:: bash + .. code-block:: console $ python setup.py build_sphinx -a @@ -88,7 +88,7 @@ Options for setuptools integration This can also be set by passing the `-s` flag to ``setup.py``: - .. code-block:: bash + .. code-block:: console $ python setup.py build_sphinx -s $SOURCE_DIR @@ -105,7 +105,7 @@ Options for setuptools integration This can also be set by passing the `-c` flag to ``setup.py``: - .. code-block:: bash + .. code-block:: console $ python setup.py build_sphinx -c $CONFIG_DIR @@ -117,7 +117,7 @@ Options for setuptools integration This can also be set by passing the `-b` flag to ``setup.py``: - .. code-block:: bash + .. code-block:: console $ python setup.py build_sphinx -b $BUILDER @@ -131,7 +131,7 @@ Options for setuptools integration This can also be set by passing the `-W` flag to ``setup.py``: - .. code-block:: bash + .. code-block:: console $ python setup.py build_sphinx -W @@ -169,7 +169,7 @@ Options for setuptools integration This can also be set by passing the `-i` flag to ``setup.py``: - .. code-block:: bash + .. code-block:: console $ python setup.py build_sphinx -i diff --git a/doc/usage/installation.rst b/doc/usage/installation.rst index 4b016f8f0..cd197dc62 100644 --- a/doc/usage/installation.rst +++ b/doc/usage/installation.rst @@ -239,13 +239,13 @@ PDF builds using LaTeX. Please choose one for your purpose. commands. For example, you can use following command to create a Sphinx project: - .. code-block:: bash + .. code-block:: console $ docker run -it --rm -v /path/to/document:/docs sphinxdoc/sphinx sphinx-quickstart And you can following command this to build HTML document: - .. code-block:: bash + .. code-block:: console $ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx make html diff --git a/doc/usage/quickstart.rst b/doc/usage/quickstart.rst index 8644a0021..abfa269d8 100644 --- a/doc/usage/quickstart.rst +++ b/doc/usage/quickstart.rst @@ -39,7 +39,7 @@ Sphinx comes with a script called :program:`sphinx-quickstart` that sets up a source directory and creates a default :file:`conf.py` with the most useful configuration values from a few questions it asks you. To use this, run: -.. code-block:: shell +.. code-block:: console $ sphinx-quickstart @@ -128,7 +128,7 @@ Running the build Now that you have added some files and content, let's make a first build of the docs. A build is started with the :program:`sphinx-build` program: -.. code-block:: shell +.. code-block:: console $ sphinx-build -b html sourcedir builddir @@ -144,7 +144,7 @@ However, :program:`sphinx-quickstart` script creates a :file:`Makefile` and a :file:`make.bat` which make life even easier for you. These can be executed by running :command:`make` with the name of the builder. For example. -.. code-block:: shell +.. code-block:: console $ make html diff --git a/doc/usage/theming.rst b/doc/usage/theming.rst index f6a9460ec..f66734b96 100644 --- a/doc/usage/theming.rst +++ b/doc/usage/theming.rst @@ -70,7 +70,7 @@ directory containing :file:`conf.py` and use this configuration:: The third form is a Python package. If a theme you want to use is distributed as a Python package, you can use it after installing -.. code-block:: bash +.. code-block:: console # installing theme package $ pip install sphinxjp.themes.dotted |