Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add inline tabs on Documentation Getting Started page for commands on different systems #1224

Merged
merged 5 commits into from
Nov 23, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 30 additions & 11 deletions documentation/start-documenting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
Getting started
===============

.. raw:: html

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

.. highlight:: rest

The Python language has a substantial body of documentation, much of it
Expand Down Expand Up @@ -81,22 +89,33 @@ Create a virtual environment
----------------------------

.. _doc-create-venv-unix:
.. _doc-create-venv-windows:

**On Unix platforms** that support :program:`make`
(including Linux, macOS and BSD),
you can create a new :mod:`venv` with the required dependencies using::
You can create a new :mod:`venv` with the required dependencies using:

make venv
.. tab:: Unix
lancegoyke marked this conversation as resolved.
Show resolved Hide resolved

Building the docs with :program:`make` will automatically use this environment
without you having to activate it.
.. code-block:: shell

.. _doc-create-venv-windows:
make venv

Building the docs with :program:`make` will automatically use this environment
without you having to activate it.

.. tab:: macOS

.. code-block:: shell

make venv

Building the docs with :program:`make` will automatically use this environment
without you having to activate it.
lancegoyke marked this conversation as resolved.
Show resolved Hide resolved

.. tab:: Windows

**On Windows**, or if not using :program:`make`,
`create a new virtual environment <venv-create_>`__ manually.
Always be sure to `activate this environment <venv-activate_>`__
before building the documentation.
`Create a new virtual environment <venv-create_>`__ manually.
Always be sure to `activate this environment <venv-activate_>`__
before building the documentation.


.. _building-using-make:
Expand Down
Loading