Skip to content

Commit edc11b9

Browse files
a few finishing touches on documentation updates
1 parent c7e8dd7 commit edc11b9

File tree

3 files changed

+26
-4
lines changed

3 files changed

+26
-4
lines changed

docs/_static/SoftLayer-Python.png

-1.83 MB
Binary file not shown.

docs/dev/index.rst

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ Python Bindings project.
99
Code Organization
1010
-----------------
1111

12-
.. image: _static/SoftLayer-Python.png
12+
13+
.. image:: /images/SoftLayer-Python.png
14+
:width: 800
15+
:alt: SoftLayer-Python Architecture Diagram
1316

1417

1518
Setting Up A Dev Environment
@@ -110,9 +113,9 @@ Documentation
110113
-------------
111114
The project is documented in
112115
`reStructuredText <http://sphinx-doc.org/rest.html>`_ and built using
113-
`Sphinx <http://sphinx-doc.org/>`_. If you have
114-
`fabric <http://fabfile.org>`_ installed, you simply need to run the following
115-
to build the docs:
116+
`Sphinx <http://sphinx-doc.org/>`_.
117+
118+
For testing locally you can run the following command to build the HTML for this project
116119

117120
::
118121

@@ -122,6 +125,25 @@ to build the docs:
122125
The primary docs are built at
123126
`Read the Docs <http://softlayer-python.readthedocs.org/>`_.
124127

128+
`Recent build output for reference <https://readthedocs.org/projects/softlayer-python/builds/20780252/>`_
129+
130+
::
131+
132+
git clone --no-single-branch --depth 50 https://github.com/softlayer/softlayer-python.git .
133+
git checkout --force origin/master
134+
git clean -d -f -f
135+
python3.7 -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
136+
python -m pip install --upgrade --no-cache-dir pip setuptools
137+
python -m pip install --upgrade --no-cache-dir pillow==5.4.1 mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.3 jinja2<3.1.0
138+
python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
139+
cat docs/conf.py
140+
python -m sphinx -T -E -b dirhtml -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
141+
python -m sphinx -T -E -b readthedocssinglehtmllocalmedia -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/htmlzip
142+
python -m sphinx -T -E -b latex -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/pdf
143+
cat latexmkrc
144+
latexmk -r latexmkrc -pdf -f -dvi- -ps- -jobname=softlayer-python -interaction=nonstopmode
145+
python -m sphinx -T -E -b epub -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/epub
146+
125147

126148
Style
127149
-----

0 commit comments

Comments
 (0)