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.

Sign up for GitHub

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

Jump to bottom

Fix broken docs links #4677

Merged
merged 1 commit into from
Sep 29, 2018
Merged

Fix broken docs links #4677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion docs/builds.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,9 @@ Writing your own builder

The documentation build system in RTD is made pluggable, so that you can build out your own backend. If you have a documentation format that isn't currently supported, you can add support by contributing a backend.

The builders in :doc:`/developer-interface/doc_builder` detail the higher level parts of the API that you need to implement. A basic run goes something like this::
`The builder backends`_ detail the higher level parts of the API that you need to implement. A basic run goes something like this:

.. sourcecode:: python

backend = get_backend(project.documentation_type)
if force:
Expand All @@ -196,6 +198,8 @@ The builders in :doc:`/developer-interface/doc_builder` detail the higher level
if success:
backend.move(version)

.. _The builder backends: https://github.com/rtfd/readthedocs.org/tree/master/readthedocs/doc_builder/backends

Deleting a stale or broken build environment
--------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/design/theme-context.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Note that this dictionary is injected under the main key `readthedocs`:
so it's your responsibility to use this context in a proper way.

In case you want *fresh data* at the moment of reading your documentation,
you should consider using the :doc:`Read the Docs Public API <api>` via Javascript.
you should consider using the :doc:`Read the Docs Public API </api/index>` via Javascript.


Using Read the Docs context in your theme
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/specifying-dependencies.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The file's path should be relative to documentation root.

requirements_file: requirements.txt

See :doc:`yaml-config` for setting up the .yml file
See :doc:`/yaml-config` for setting up the .yml file

Using the project admin dashboard
---------------------------------
Expand All @@ -43,7 +43,7 @@ Using a conda environment file

If using conda, the dependencies can be specified in the conda environment file, ``environment.yml`` .

More on Read the Doc's conda support: :doc:`conda`
More on Read the Doc's conda support: :doc:`/conda`

Working with `conda and environment.yml`_

Expand Down