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

Support for DirectoryHTMLBuilder #21

Merged
merged 7 commits into from
Dec 13, 2019
Merged

Conversation

ruksi
Copy link
Contributor

@ruksi ruksi commented Dec 11, 2019

Let's imagine a project with the following documentation structure:

index.rst
faq.rst
downloads/index.rst
downloads/linux.rst

sphinx-sitemap would generate a sitemap with:

https://example.com/index.html
https://example.com/faq.html
https://example.com/downloads/index.html
https://example.com/downloads/linux.html

But as we are using DirectoryHTMLBuilder, Sphinx will actually build:

https://example.com/index.html
https://example.com/faq/index.html              <- wrong in sitemap
https://example.com/downloads/index.html
https://example.com/downloads/linux/index.html  <- wrong in sitemap

And thus, as we want to use "directory" style URLs:

https://example.com/
https://example.com/faq/
https://example.com/downloads/
https://example.com/downloads/linux/

Which the main beef of this pull request.

Additionally:

  • upgrade from deprecated pep8 to pycodestyle
  • remove some unused code
  • ignore a couple development related directories

Cheers!

@jdillard jdillard merged commit cdd586f into jdillard:master Dec 13, 2019
@jdillard
Copy link
Owner

Thank you! Your changes are now in the latest version on PyPI.

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.

2 participants