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

Post: "Builds with no index.html file" #230

Merged
merged 4 commits into from
Jul 25, 2023
Merged

Post: "Builds with no index.html file" #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
60f8539
Post: "Builds with no `index.html` file"
humitos Jul 19, 2023
5078afb
References :(
humitos Jul 20, 2023
9bad5c2
Update with the content from the reviewed email
humitos Jul 20, 2023
3ce1cfd
Change date
humitos Jul 25, 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
2 changes: 1 addition & 1 deletion build-errors-docutils-0-18.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ If you still experience problems, feel free to
`open an issue <https://github.com/readthedocs/readthedocs.org/issues/>`_.

.. seealso::
:doc:`readthedocs:guides/setup/configuration-file`
:doc:`readthedocs:config-file/index`
An introduction to our configuration file and some basic usage examples

:ref:`.readthedocs.yaml python.install options <readthedocs:config-file/v2:python.install>`
Expand Down
24 changes: 24 additions & 0 deletions builds-without-index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. post:: July 25, 2023
:tags: builders
:author: Manuel
:location: BCN
:category: Changelog

Builds with no ``index.html`` at its output's directory are deprecated
======================================================================

Historically, Read the Docs has created an auto-generated ``index.html`` file with minimal instructions about how to setup the project correctly when your build didn’t output this file.
This auto-generated file has confused more users than it has helped because the behavior on Read the Docs was different from the behavior on their local environment.

To better onboard users, we have deprecated the auto-creation of ``index.html`` files on Read the Docs projects.
We will now check for an ``index.html`` file at the end of the build,
and fail it with a clear message of the problem if there is no ``index.html`` file in the top level of your output directory.

Builds from projects that are not generating an ``index.html`` file **will start to fail on August 1st**.
Make sure your project is properly configured and it’s creating an ``index.html`` file before that date to avoid unexpected behaviors.

We recommend you following our :doc:`tutorial <readthedocs:tutorial/index>` to set up your project correctly.

Please, `contact us`_ and let us know any inconvenient you may have with this change.

.. _contact us: mailto:[email protected]
2 changes: 1 addition & 1 deletion migrate-configuration-v2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ you should be able to define a working configuration file and avoid breaking cha

.. seealso::

:doc:`readthedocs:guides/setup/configuration-file`
:doc:`readthedocs:config-file/index`
More usage examples and guidance can be found in our how-to for adding a ``.readthedocs.yaml`` configuration file.


Expand Down
2 changes: 1 addition & 1 deletion newsletter-july-2023.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ News and updates
including the latest stable versions of Python, PyPy, Node.js, Rust and Go.
See the documentation of the `build.tools <https://docs.readthedocs.io/page/config-file/v2.html#build-tools>`__ for more info.
- 📚️ A new documentation how-to for ``.readthedocs.yaml`` was started at `Write the Docs <https://www.writethedocs.org/>`__ and finished recently.
Read it here: :doc:`readthedocs:guides/setup/configuration-file`.
Read it here: :doc:`readthedocs:config-file/index`.
- ⏩️ HTTP speedups: Several HTTP endpoints and CloudFlare configurations have been tweaked and are performing better.
- 🐛️ Bug fix: We are now 100% relying on search indexing by parsing HTML, instead of special Sphinx-only logic. This makes search a lot simpler and more consistent for our users.

Expand Down