Skip to content

Miscellaneous doc improvements #8118

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

Merged
merged 6 commits into from
Apr 20, 2021
Merged
Show file tree
Hide file tree
Changes from all 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
10 changes: 4 additions & 6 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -236,12 +236,10 @@ following contents::

src/python/

Please note that the path must be relative to the file. So the example path
above would work if the file is in the root of your repository. If you want to
put the requirements in a file called ``requirements/requirements.txt``, the
contents would look like::

../python/
Please note that the path must be relative to the working directory where ``pip`` is launched,
rather than the directory where the requirements file is located.
Therefore, even if you want to move the requirements file to a ``requirements/`` directory,
the example path above would work.

You can customize the path to your requirements file and any other installed dependency
using a Read the Docs :doc:`config-file/index`.
Expand Down
11 changes: 5 additions & 6 deletions docs/guides/feature-flags.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
Feature Flags
=============

Read the Docs offers some additional flag settings which can be only be configured by the site admin.
These are optional settings and you might not need it for every project.
By default, these flags are disabled for every project.
A separate request can be made by `contacting us via email`_ to enable
or disable one or more of these featured flags for a particular project.
Read the Docs offers some additional flag settings
which are disabled by default for every project
and can only be enabled by `contacting us through our support form`_
or reaching out to the administrator of your service.

.. _contacting us via email: mailto:support@readthedocs.org
.. _contacting us through our support form: https://docs.readthedocs.io/en/stable/support.html

Available Flags
---------------
Expand Down
7 changes: 6 additions & 1 deletion docs/hosting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,12 @@ Custom Not Found (404) Pages
If you want your project to use a custom page for not found pages instead of the "Maze Found" default,
you can put a ``404.html`` at the top level of your project's HTML output.

When a 404 is returned, Read the Docs checks if there is a ``404.html`` in the root of your project's output and uses it if it exists.
When a 404 is returned,
Read the Docs checks if there is a ``404.html`` in the root of your project's output
corresponding to the *current* version
and uses it if it exists.
Otherwise, it tries to fall back to the ``404.html`` page
corresponding to the *default* version of the project.

We recommend the `sphinx-notfound-page`_ extension,
which Read the Docs maintains.
Expand Down