mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-07 10:04:07 +00:00
79 lines
2.7 KiB
ReStructuredText
79 lines
2.7 KiB
ReStructuredText
.. _contributing/docs:
|
|
|
|
==========================
|
|
Contributing Documentation
|
|
==========================
|
|
|
|
Documentation is often more important than code. This page helps
|
|
you get set up on how to contribute documentation to JupyterHub.
|
|
|
|
Building documentation locally
|
|
==============================
|
|
|
|
We use `sphinx <http://sphinx-doc.org>`_ to build our documentation. It takes
|
|
our documentation source files (written in `markdown
|
|
<https://daringfireball.net/projects/markdown/>`_ or `reStructuredText
|
|
<http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ &
|
|
stored under the ``docs/source`` directory) and converts it into various
|
|
formats for people to read. To make sure the documentation you write or
|
|
change renders correctly, it is good practice to test it locally.
|
|
|
|
#. Make sure you have successfuly completed :ref:`contributing/setup`.
|
|
|
|
#. Install the packages required to build the docs.
|
|
|
|
.. code-block:: bash
|
|
|
|
python3 -m pip install -r docs/requirements.txt
|
|
|
|
#. Build the html version of the docs. This is the most commonly used
|
|
output format, so verifying it renders as you should is usually good
|
|
enough.
|
|
|
|
.. code-block:: bash
|
|
|
|
cd docs
|
|
make html
|
|
|
|
This step will display any syntax or formatting errors in the documentation,
|
|
along with the filename / line number in which they occurred. Fix them,
|
|
and re-run the ``make html`` command to re-render the documentation.
|
|
|
|
#. View the rendered documentation by opening ``build/html/index.html`` in
|
|
a web browser.
|
|
|
|
.. tip::
|
|
|
|
On macOS, you can open a file from the terminal with ``open <path-to-file>``.
|
|
On Linux, you can do the same with ``xdg-open <path-to-file>``.
|
|
|
|
|
|
.. _contributing/docs/conventions:
|
|
|
|
Documentation conventions
|
|
=========================
|
|
|
|
This section lists various conventions we use in our documentation. This is a
|
|
living document that grows over time, so feel free to add to it / change it!
|
|
|
|
Our entire documentation does not yet fully conform to these conventions yet,
|
|
so help in making it so would be appreciated!
|
|
|
|
``pip`` invocations
|
|
-------------------
|
|
|
|
There are three ways to invoke a ``pip`` command:
|
|
|
|
1. ``pip``
|
|
This points to python3 pip if you are in an appropriate environment,
|
|
but in some cases it can actually point to a python2 pip.
|
|
|
|
2. ``pip3``
|
|
When present, this always points to a python3 pip, most likely in
|
|
the same environment as your python3.
|
|
|
|
3. ``python3 -m pip``
|
|
This invokes pip explicitly using the python3 binary that you are
|
|
currently using. This is the **recommended way** to invoke pip
|
|
in our documentation, since it is least likely to cause problems
|
|
with python3 and pip being from different environments. |