Skip to content

Commit 56280b3

Browse files
committed
Cleanup from review
1 parent f402693 commit 56280b3

File tree

2 files changed

+8
-15
lines changed

2 files changed

+8
-15
lines changed

docs/faq.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,6 @@ are `numpydoc <https://github.com/numpy/numpydoc>`_ and
185185
output more closely matches the format of standard Sphinx annotations,
186186
and as a result, it tends to look a bit better with the default theme.
187187

188-
.. _faq_document_package_not_at_root:
189-
190188
Can I document a python package that is not at the root of my repository?
191189
-------------------------------------------------------------------------
192190

docs/guides/specifying-dependencies.rst

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Any dependencies required for building a documentation project can be specified
77

88
Specifying a requirements file
99
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10+
1011
The requirements file option is useful for specifying dependencies required for building the documentation. Additional uses specific to Read the Docs are mentioned at the end of this guide.
1112

1213
For details about the purpose of pip requirements file and how to create one, check out `pip user guide`_
@@ -17,7 +18,8 @@ To use the requirements file, create and place the requirements file in the root
1718

1819
Using the YAML configuration file
1920
---------------------------------
20-
The recommended approach for specifying a pip requirements file is to use a readthedocs.yml file.
21+
22+
The recommended approach for specifying a pip requirements file is to use a ``readthedocs.yml`` file.
2123

2224
The file's path should be relative to documentation root.
2325

@@ -38,6 +40,7 @@ Once the requirements file has been created;
3840

3941
Using a conda environment file
4042
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43+
4144
If using conda, the dependencies can be specified in the conda environment file, ``environment.yml`` .
4245

4346
More on Read the Doc's conda support: :doc:`conda`
@@ -50,18 +53,10 @@ This conda environment file can be specified in ``readthedocs.yml`` in the ``con
5053

5154
.. code-block:: yaml
5255
53-
conda:
54-
file: environment.yml
56+
conda:
57+
file: environment.yml
5558
5659
As before, the path should be relative to the documentation repository root.
5760

58-
Additional Uses
59-
~~~~~~~~~~~~~~~
60-
- Documenting multiple packages
61-
- setup.py not in root directory
62-
63-
See :ref:`faq_document_package_not_at_root`
64-
65-
66-
.. _`pip user guide`: : https://pip.pypa.io/en/stable/user_guide/#requirements-files
67-
.. _`conda and environment.yml`: : https://conda.io/docs/user-guide/tasks/manage-environments.html
61+
.. _`pip user guide`: https://pip.pypa.io/en/stable/user_guide/#requirements-files
62+
.. _`conda and environment.yml`: https://conda.io/docs/user-guide/tasks/manage-environments.html

0 commit comments

Comments
 (0)