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

Warn or Fail build if there is no index.html generated #1800

Closed
ericholscher opened this issue Oct 30, 2015 · 12 comments · Fixed by #10550
Closed

Warn or Fail build if there is no index.html generated #1800

ericholscher opened this issue Oct 30, 2015 · 12 comments · Fixed by #10550
Assignees
@humitos
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Milestone
Build stability

Comments

@ericholscher
Copy link
Member

Docs look broken when there isn't an index file to serve. We should probably be validating that an index.html or a README.html exists, which we will serve at the root of their docs.
@ericholscher ericholscher added the Improvement Minor improvement to code label Oct 30, 2015
@humitos
Copy link
Member

humitos commented Dec 29, 2017

I think this is already implemented since when there is no index.html generated RTD generates one for us with a message which also points to the "Getting Started Guide" at #3447

@ericholscher If that's the issue, can we close this one?

@ericholscher
Copy link
Member Author

Believe this should still be the case. People can still have no index.[md|rst] and have a build pass. We're only generating them if there is no sphinx/mkdocs config found.

@stsewd
Copy link
Member

stsewd commented Jan 7, 2018 •
edited
Loading

Related issue #2483

For the record:

  • The builds already fails if there is no index file (sphinx or empty project).
  • If the user change the master_doc (other name than index), the build pass, but the docs at / gives 404.

@stsewd stsewd mentioned this issue Jun 1, 2018
Closed
@agjohnson
Copy link
Contributor

This is also very easy to hit with mkdocs.

@agjohnson agjohnson added the Accepted Accepted issue on our roadmap label Sep 19, 2018
@agjohnson agjohnson added this to the Build stability milestone Sep 19, 2018
@stsewd
Copy link
Member

stsewd commented Nov 27, 2018

I don't think we have a way to indicate a waning in the build process. Also, mkdocs already handle the case where users have a README file, so, we can't just check for a missing index file, we could do the check in the generated docs.

@stsewd stsewd added the Needed: design decision A core team decision is required label Nov 27, 2018
@stsewd
Copy link
Member

stsewd commented Nov 27, 2018

Also, now sphinx-quickstart suggest an index file by default, which can help to have fewer users without an index file.

@stsewd stsewd mentioned this issue Apr 24, 2019
Merged
@humitos
Copy link
Member

humitos commented Jul 21, 2020

Checking for index.html after build instead of at build time (checking for .md or .rst) is good. I just found an example where the index.html comes from an static .html file and we were creating an index.md that overrides the static file the user wanted. See #7305

@ericholscher
Copy link
Member Author

Yea -- we should be able to figure this out via ImportedFile objects, and wouldn't be a hard feature to build I think 👍

@chrisjsewell
Copy link
Contributor

FYI, I was just bitten by this in executablebooks/sphinx-external-toc#1 (comment)

@chrisjsewell chrisjsewell mentioned this issue Apr 11, 2021
Closed
@humitos
Copy link
Member

humitos commented Jul 4, 2023

We did some work to start logging what are the projects where we are creating the index.html file automatically at #10471. After some weeks we will contact them telling we are removing this feature.

I'm assigning this issue to myself so I work on this in the next weeks.

@humitos humitos self-assigned this Jul 4, 2023
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Jul 4, 2023
@humitos humitos removed the Needed: design decision A core team decision is required label Jul 4, 2023
@ericholscher ericholscher moved this from Planned to In progress in 📍Roadmap Jul 5, 2023
This was referenced Jul 6, 2023
Closed
Closed
@humitos
Copy link
Member

humitos commented Jul 17, 2023

We have some logs already at https://onenr.io/0LwGgpA0Yw6. It seems we have around ~114 projects (.org and .com combined)

humitos added a commit to readthedocs/blog that referenced this issue Jul 19, 2023
@humitos
Post: "Builds with no index.html file"
60f8539 
Minimal changelog post announcing readthedocs/readthedocs.org#1800

Currently, we are logging this projects, but on August 1st we will be failing
builds that do not generate an `index.html` on the output's directory.
@humitos humitos mentioned this issue Jul 19, 2023
Merged
@humitos
Copy link
Member

humitos commented Jul 19, 2023

We sent the email today 📧 🚀

humitos added a commit that referenced this issue Jul 19, 2023
@humitos
Build: fail builds if there is no index.html in the output dir
9281e1b 
We announced we deprecated this in readthedocs/blog#230
and we already contacted the users to warn about this.

This PR has to be merged after July 25th, 2023 and it has to be deployed on
August 1st.

Closes #1800
@humitos humitos mentioned this issue Jul 19, 2023
Merged
@humitos humitos moved this from In progress to Needs review in 📍Roadmap Jul 19, 2023
humitos added a commit to readthedocs/blog that referenced this issue Jul 25, 2023
@humitos
Post: "Builds with no index.html file" (#230)
a05e582 
* Post: "Builds with no `index.html` file"

Minimal changelog post announcing readthedocs/readthedocs.org#1800

Currently, we are logging this projects, but on August 1st we will be failing
builds that do not generate an `index.html` on the output's directory.

* References :(

* Update with the content from the reviewed email

* Change date
@github-project-automation github-project-automation bot moved this from Needs review to Done in 📍Roadmap Jul 26, 2023
humitos added a commit that referenced this issue Jul 26, 2023
@humitos @ericholscher
Build: fail builds if there is no index.html in the output dir (#10550
31bd5ad 
)

* Build: fail builds if there is no `index.html` in the output dir

We announced we deprecated this in readthedocs/blog#230
and we already contacted the users to warn about this.

This PR has to be merged after July 25th, 2023 and it has to be deployed on
August 1st.

Closes #1800

* Test: create an "index.html" to run build successfully

---------

Co-authored-by: Eric Holscher <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@humitos humitos

Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Projects
📍Roadmap
Archived in project
Milestone
Build stability
Development

Successfully merging a pull request may close this issue.

Build: fail builds if there is no index.html in the output dir readthedocs/readthedocs.org
5 participants
@ericholscher @humitos @agjohnson @chrisjsewell @stsewd