Skip to content

Allow build.commands without build.tools #10281

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

Merged
merged 10 commits into from
May 2, 2023
Merged

Allow build.commands without build.tools #10281

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f317061
Adjust tests
benjaoming Apr 30, 2023
4638b71
Update validation to allow build.commands without build.tools
benjaoming Apr 30, 2023
532cc79
Remove comments, adds a negative test about re: "`build.jobs` can't b…
benjaoming May 1, 2023
282b77d
Rename BuildWithTools => BuildWithOs
benjaoming May 1, 2023
7281071
Not legacy, still supported!
benjaoming May 1, 2023
f413969
Make test case command not confuse, it should make sense
benjaoming May 1, 2023
631e5f8
Adds a note to remember to create the folders before adding content
benjaoming May 1, 2023
9dabd72
Improve a docs sentence
benjaoming May 1, 2023
76851d5
Use $READTHEDOCS_OUTPUT in examples
benjaoming May 1, 2023
f5cc42f
Update docs/user/build-customization.rst
benjaoming May 1, 2023
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
12 changes: 7 additions & 5 deletions docs/user/build-customization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,12 +362,14 @@ Where to put files
It is your responsibility to generate HTML and other formats of your documentation using :ref:`config-file/v2:build.commands`.
The contents of the ``_readthedocs/<format>/`` directory will be hosted as part of your documentation.

We store the the base folder name ``_readthedocs/`` in the environment variable ``$READTHEDOCS_OUTPUT`` and encourage that you use this to generate paths.

Supported :ref:`formats <downloadable-documentation:accessing offline formats>` are published if they exist in the following directories:

* ``_readthedocs/html/`` (required)
* ``_readthedocs/htmlzip/``
* ``_readthedocs/pdf/``
* ``_readthedocs/epub/``
* ``$READTHEDOCS_OUTPUT/html/`` (required)
* ``$READTHEDOCS_OUTPUT/htmlzip/``
* ``$READTHEDOCS_OUTPUT/pdf/``
* ``$READTHEDOCS_OUTPUT/epub/``

.. note::

Expand All @@ -376,7 +378,7 @@ Supported :ref:`formats <downloadable-documentation:accessing offline formats>`

.. code-block:: console

mkdir -p _readthedocs/html/
mkdir -p $READTHEDOCS_OUTPUT/html/

Search support
~~~~~~~~~~~~~~
Expand Down