Skip to content

Commit

Permalink
Add inline tabs on Helping with the Developer’s Guide page for comman…
Browse files Browse the repository at this point in the history
…ds on different systems (#1223)
  • Loading branch information
lancegoyke authored Nov 19, 2023
1 parent cc50bac commit 20979d9
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions documentation/devguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@
Helping with the Developer's Guide
==================================

.. raw:: html

<script>
document.addEventListener('DOMContentLoaded', function() {
activateTab(getOS());
});
</script>

.. highlight:: console

The Developer's Guide (what you're reading now) uses the same process as the
Expand Down Expand Up @@ -32,15 +40,21 @@ To build the devguide, some additional dependencies are required (most
importantly, `Sphinx`_), and the standard way to install dependencies in
Python projects is to create a virtualenv, and then install dependencies from
a ``requirements.txt`` file. For your convenience, this is all *automated for
you*. To build the devguide on a Unix-like system use::
you*.

To build the devguide from the checkout directory:

.. tab:: Unix/macOS

.. code-block:: shell
$ make html
make html
in the checkout directory. On Windows use:
.. tab:: Windows

.. code-block:: doscon
.. code-block:: dosbatch
> .\make html
.\make html
You will find the generated files in ``_build/html``.

Expand Down

0 comments on commit 20979d9

Please sign in to comment.