IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Fix use of code console

Browse Source
This commit is contained in:
Aaron Carlisle 2019-10-23 11:08:08 -04:00
parent c04c214a85
commit a4bacd2bab
3 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -31,7 +31,7 @@ This theme is distributed on PyPI_ and can be installed with ``pip``:
.. code:: console .. 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 To use the theme in your Sphinx project, you will need to add the following to
your ``conf.py`` file: your ``conf.py`` file:

16
docs/contributing.rst
View File

@ -24,13 +24,13 @@ Set up your environment
.. code:: console .. code:: console
pip install -e '.[dev]' $ pip install -e '.[dev]'
#. Install Webpack_, node-sass_, and theme dependencies locally. #. Install Webpack_, node-sass_, and theme dependencies locally.
.. code:: console .. code:: console
npm install $ npm install
Making changes Making changes
-------------- --------------
@ -39,7 +39,7 @@ Changes to the theme can be compiled and tested with Webpack_:
.. code:: console .. code:: console
npm run dev $ npm run dev
This script will do the following: This script will do the following:
@ -54,7 +54,7 @@ can be used to test built assets:
.. code:: console .. code:: console
npm run build $ npm run build
.. _Webpack: https://webpack.js.org/ .. _Webpack: https://webpack.js.org/
.. _node-sass: https://github.com/sass/node-sass .. _node-sass: https://github.com/sass/node-sass
@ -76,7 +76,7 @@ the following:
.. code:: console .. code:: console
python setup.py update_translations $ python setup.py update_translations
This will extract new messages, upload the messages to Transifex, and will 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 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 .. code:: console
rm -rf dist/ $ rm -rf dist/
python setup.py sdist bdist_wheel $ python setup.py sdist bdist_wheel
twine upload --sign --identity security@readthedocs.org dist/* $ twine upload --sign --identity security@readthedocs.org dist/*
.. _PEP440: https://www.python.org/dev/peps/pep-0440/ .. _PEP440: https://www.python.org/dev/peps/pep-0440/

2
docs/installing.rst
View File

@ -6,7 +6,7 @@ Install the package (or add it to your ``requirements.txt`` file):
.. code:: console .. code:: console
pip install sphinx_rtd_theme $ pip install sphinx_rtd_theme
In your ``conf.py`` file: In your ``conf.py`` file: