From a4bacd2babf95cf5bf2413db522ed2681c93fd8b Mon Sep 17 00:00:00 2001 From: Aaron Carlisle Date: Wed, 23 Oct 2019 11:08:08 -0400 Subject: [PATCH] Docs: Fix use of code console --- README.rst | 2 +- docs/contributing.rst | 16 ++++++++-------- docs/installing.rst | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 26251f81..4c7f6db2 100644 --- a/README.rst +++ b/README.rst @@ -31,7 +31,7 @@ This theme is distributed on PyPI_ and can be installed with ``pip``: .. code:: console - pip install sphinx-rtd-theme + $ pip install sphinx-rtd-theme To use the theme in your Sphinx project, you will need to add the following to your ``conf.py`` file: diff --git a/docs/contributing.rst b/docs/contributing.rst index 971e6ca0..5206b62b 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -24,13 +24,13 @@ Set up your environment .. code:: console - pip install -e '.[dev]' + $ pip install -e '.[dev]' #. Install Webpack_, node-sass_, and theme dependencies locally. .. code:: console - npm install + $ npm install Making changes -------------- @@ -39,7 +39,7 @@ Changes to the theme can be compiled and tested with Webpack_: .. code:: console - npm run dev + $ npm run dev This script will do the following: @@ -54,7 +54,7 @@ can be used to test built assets: .. code:: console - npm run build + $ npm run build .. _Webpack: https://webpack.js.org/ .. _node-sass: https://github.com/sass/node-sass @@ -76,7 +76,7 @@ the following: .. code:: console - python setup.py update_translations + $ python setup.py update_translations This will extract new messages, upload the messages to Transifex, and will update our local translation files. Changes can be checked in to a branch and @@ -105,8 +105,8 @@ To release a new version of the theme, core team will take the following steps: .. code:: console - rm -rf dist/ - python setup.py sdist bdist_wheel - twine upload --sign --identity security@readthedocs.org dist/* + $ rm -rf dist/ + $ python setup.py sdist bdist_wheel + $ twine upload --sign --identity security@readthedocs.org dist/* .. _PEP440: https://www.python.org/dev/peps/pep-0440/ diff --git a/docs/installing.rst b/docs/installing.rst index cf209e98..7b78ee6d 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -6,7 +6,7 @@ Install the package (or add it to your ``requirements.txt`` file): .. code:: console - pip install sphinx_rtd_theme + $ pip install sphinx_rtd_theme In your ``conf.py`` file: