EbookFoundation
/
readthedocs.org
mirror of https://github.com/EbookFoundation/readthedocs.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix broken docs links

blendify/new_ga
David Fischer 2018-09-28 16:02:09 -07:00
parent db2f2ed56e
commit 9f11a11aef
No known key found for this signature in database
GPG Key ID: F0C9B0ADA737AB60
3 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/builds.rst
View File

@ -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 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) backend = get_backend(project.documentation_type)
if force: if force:
@ -196,6 +198,8 @@ The builders in :doc:`/developer-interface/doc_builder` detail the higher level
if success: if success:
backend.move(version) 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 Deleting a stale or broken build environment
-------------------------------------------- --------------------------------------------

2
docs/design/theme-context.rst
View File

@ -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. 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, 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 Using Read the Docs context in your theme

4
docs/guides/specifying-dependencies.rst
View File

@ -27,7 +27,7 @@ The file's path should be relative to documentation root.
requirements_file: requirements.txt 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 Using the project admin dashboard
--------------------------------- ---------------------------------
@ -43,7 +43,7 @@ Using a conda environment file
If using conda, the dependencies can be specified in the conda environment file, ``environment.yml`` . 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`_ Working with `conda and environment.yml`_