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.

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

Use autosectionlabel extension #4146

Merged
merged 2 commits into from May 30, 2018

Conversation

@stsewd
Copy link
Member

@stsewd stsewd commented May 24, 2018

I just did a grep to find those links and also to make sure they aren't used in other parts. There are still some links that are used externally (like the yaml file I think) or are out of the scope like the changelog (but I think we can still have those links, going to investigate later).

Closes #4140

Copy link
Member

@humitos humitos left a comment

I like these changes. I think it's way more clear to know where we are linking to.

I would like to know what happen if we change the title of one of those linked sections. Do we get a lint error? Do we end up with a broken link?

Loading

@stsewd
Copy link
Member Author

@stsewd stsewd commented May 24, 2018

We end with a none link, the link isn't displayed. I'll see if I can extend rstcheck or use something else. reStructuredText needs a lot of tooling 🔨

Loading

@humitos
Copy link
Member

@humitos humitos commented May 29, 2018

OK. I'm interested in making the errors (as changing the title of a section) explicit and communicate them to us. Otherwise, we will end with broken links without knowing it.

Loading

@ericholscher
Copy link
Member

@ericholscher ericholscher commented May 30, 2018

We could also make the travis-ci docs check run with warnings as errors. I believe we have a few warnings already though, but if we removed all of those, it should catch incorrect references.

Loading

@stsewd
Copy link
Member Author

@stsewd stsewd commented May 30, 2018

@ericholscher I checked that yesterday, we only have one warning about the _static directory, also I tried activating the -n option, I still don't understand it (I remove some refs and everything still works)

http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky

Loading

@ericholscher
Copy link
Member

@ericholscher ericholscher commented May 30, 2018

Huh, interesting.

Loading

@ericholscher
Copy link
Member

@ericholscher ericholscher commented May 30, 2018

Loading

@ericholscher
Copy link
Member

@ericholscher ericholscher commented May 30, 2018

So it looks like our django.setup() in the conf.py is eating the logging output of Sphinx.

Loading

@ericholscher
Copy link
Member

@ericholscher ericholscher commented May 30, 2018

I actually currently don't see our default Sphinx output in the log for docs locally!

Loading

@ericholscher
Copy link
Member

@ericholscher ericholscher commented May 30, 2018

Even in prod, it's totally swallowing the Sphinx "each page" logging output:

screenshot 2018-05-30 14 45 00

Loading

@ericholscher ericholscher merged commit e507acb into readthedocs:master May 30, 2018
1 check passed
Loading
@ericholscher
Copy link
Member

@ericholscher ericholscher commented May 30, 2018

This discussion moved to #4166

Loading

@stsewd stsewd deleted the use-autosection-label branch May 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants