Skip to content

Commit

Permalink
Use sphinx-tabs
Browse files Browse the repository at this point in the history
  • Loading branch information
stsewd committed Oct 31, 2018
1 parent c505a5d commit 58d9701
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion docs/.rstcheck.cfg
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[rstcheck]
ignore_directives=automodule,http:get
ignore_directives=automodule,http:get,tabs,tab
ignore_roles=djangosetting,setting
ignore_messages=(Duplicate implicit target name: ".*")|(Hyperlink target ".*" is not referenced)
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
'sphinxcontrib.httpdomain',
'djangodocs',
'doc_extensions',
'sphinx_tabs.tabs',
]
templates_path = ['_templates']

Expand Down
52 changes: 25 additions & 27 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,43 +29,41 @@ Additionally Read the Docs depends on:
In order to get all the dependencies successfully installed,
you need these libraries.

On Mac OS
~~~~~~~~~
.. tabs::

.. tab:: Mac OS

If you are having trouble on OS X Mavericks
(or possibly other versions of OS X) with building ``lxml``,
you probably might need to use Homebrew_ to ``brew install libxml2``,
and invoke the install with::
If you are having trouble on OS X Mavericks
(or possibly other versions of OS X) with building ``lxml``,
you probably might need to use Homebrew_ to ``brew install libxml2``,
and invoke the install with::
CFLAGS=-I/usr/local/opt/libxml2/include/libxml2 \
LDFLAGS=-L/usr/local/opt/libxml2/lib \
pip install -r requirements.txt

CFLAGS=-I/usr/local/opt/libxml2/include/libxml2 \
LDFLAGS=-L/usr/local/opt/libxml2/lib \
pip install -r requirements.txt

On Ubuntu
~~~~~~~~~
.. tab:: Ubuntu

Install::
Install::

sudo apt-get install build-essential
sudo apt-get install python-dev python-pip python-setuptools
sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev
sudo apt-get install build-essential
sudo apt-get install python-dev python-pip python-setuptools
sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev

If you don't have redis installed yet, you can do it with::
sudo apt-get install redis-server
If you don't have redis installed yet, you can do it with::
sudo apt-get install redis-server

On CentOS/RHEL 7
~~~~~~~~~~~~~~~~
.. tab:: CentOS/RHEL 7

Install::
Install::

sudo yum install python-devel python-pip libxml2-devel libxslt-devel
sudo yum install python-devel python-pip libxml2-devel libxslt-devel

Other operating systems
~~~~~~~~~~~~~~~~~~~~~~~
.. tab:: Other OS

On other operating systems no further dependencies are required,
or you need to find the proper equivalent libraries.
On other operating systems no further dependencies are required,
or you need to find the proper equivalent libraries.


.. _Python 3.6: http://www.python.org/
Expand Down
1 change: 1 addition & 0 deletions requirements/pip.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ virtualenv==16.0.0
docutils==0.14
Sphinx==1.7.8
sphinx_rtd_theme==0.4.1
sphinx-tabs==1.1.7
# Required to avoid Transifex error with reserved slug
# https://github.com/sphinx-doc/sphinx-intl/pull/27
git+https://github.com/agjohnson/sphinx-intl.git@7b5c66bdb30f872b3b1286e371f569c8dcb66de5#egg=sphinx-intl
Expand Down

0 comments on commit 58d9701

Please sign in to comment.