Skip to content

Remove sphinx static and template dir #5039

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

Merged
merged 3 commits into from
Jan 3, 2019

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Dec 26, 2018

This is already handled by the rtd-sphinx-extension.

We don't override the template from rtd (#1946)

Half solves #5029

This is already handled by the rtd-sphinx-extension.

We don't override the template from rtd (readthedocs#1946)
@@ -37,7 +37,6 @@ if not 'html_static_path' in globals():
html_static_path = []
if os.path.exists('_static'):
html_static_path.append('_static')
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm tempted to remove this whole block too

@stsewd
Copy link
Member Author

stsewd commented Dec 26, 2018

Tested it locally, no more warnings, everything is working.

@stsewd stsewd requested a review from a team December 27, 2018 02:22
Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have all this flow in my mind, but before merging this we would be sure that,

  • this is not something needed for the corporate site
  • we don't need to override any Sphinx template never again :)
  • by removing this, we still do have another way to override a Sphinx template (using our extension for example)

After checking these three steps, I think we are fine to merge (didn't review the PR yet, though).

@stsewd
Copy link
Member Author

stsewd commented Jan 2, 2019

this is not something needed for the corporate site

I didn't find any reference in .com

we don't need to override any Sphinx template never again :)
by removing this, we still do have another way to override a Sphinx template (using our extension for example)

I think we should stay away of modifying the theme inside the rtd, all that should be managed by the extension, that way is less likely to break in case we update sphinx, or users can pin to a compatible version of the extension.

@stsewd stsewd requested a review from a team January 3, 2019 00:33
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. I don't believe we'll want to do this in a hacky way any time in the future. 👍

@humitos
Copy link
Member

humitos commented Jan 3, 2019

OK! I suppose we are fine, then.

@humitos humitos merged commit f4d3a93 into readthedocs:master Jan 3, 2019
@stsewd stsewd deleted the remove-static-path branch January 3, 2019 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants