You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+2-12Lines changed: 2 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,24 +123,14 @@ When editing the documentation installing ``sphinx-autobuild`` though pip can be
123
123
3. Watch for file changes ``make SPHINXBUILD=sphinx-autobuild html``
124
124
4. Open http://127.0.0.1:8000 in the browser and start editing
125
125
126
-
Building PDF
127
-
============
128
-
129
-
1. Follow instructions for "Building HTML" above
130
-
2. Install ``latexmk`` and ``texlive-latex-extra`` - https://pipenv.readthedocs.io/en/latest/
131
-
3. Create a Python environment (typically inside this repository): ``pipenv --python 3.9``
132
-
4. Change into the environment: ``pipenv shell``
133
-
5. Install the dependencies ``pip install -r docs/requirements.txt``
134
-
6. Now you can use ``make ...`` to build all the stuff - for example ``make pdf`` to build the PDF flavor of all manuals
135
-
136
126
Using the VSCode DevContainer
137
127
=============================
138
128
139
129
This repository contains a full-featured `VSCode DevContainer <https://code.visualstudio.com/docs/devcontainers/containers>`_.
140
130
You can use it in your local development environment or via `GitHub Codespaces <https://github.com/features/codespaces>`_.
141
131
Just open the container an use one of the commands from above to build the project. For example ``make`` to build the full
142
-
documentation, ``make html`` to build the HTML documentation or ``make pdf`` to build the PDF documentation. You can also use
143
-
``make SPHINXBUILD=sphinx-autobuild html`` in combination with `port forwarding <https://code.visualstudio.com/docs/devcontainers/containers#_forwarding-or-publishing-a-port>`_
132
+
documentation. You can also use ``make SPHINXBUILD=sphinx-autobuild html``
133
+
in combination with `port forwarding <https://code.visualstudio.com/docs/devcontainers/containers#_forwarding-or-publishing-a-port>`_
144
134
to watch file changes and automatically reload the html preview.
0 commit comments