Skip to main content

Sitemap generator for Sphinx

Project description

`Sphinx <http://sphinx-doc.org/>`__ extension to silently generate a sitemaps.org compliant sitemap for the HTML version of your Sphinx Documentation.

Build Status

Installing

  1. Add/set the value of base_url in your Sphinx conf.py to the current base URL of your documentation. For example, https://my-site.com/docs/.

  2. Copy the sphinx_sitemap directory into your extensions directory or sys.path, then add sphinx_sitemap to the extensions array in your Sphinx conf.py.

    Note: sphinx-sitemap supports Sphinx 1.2 and later, and Python 2.7, 3.3, and 3.4.

License

sphinx-sitemap is made available under a MIT license; see LICENSE for details.

Originally based on the sitemap generator in the guzzle_sphinx_theme project licensed under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-sitemap-0.2.tar.gz (2.9 kB view details)

Uploaded Source

File details

Details for the file sphinx-sitemap-0.2.tar.gz.

File metadata

  • Download URL: sphinx-sitemap-0.2.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sphinx-sitemap-0.2.tar.gz
Algorithm Hash digest
SHA256 0a8a556c5246eb1662341a36037948235ebf54429cb1faea231083fd2d163d1f
MD5 2c06c48367a7e93c5f4d9748e29dd72b
BLAKE2b-256 4b440c6996412c88585d1df8a1b39fc72a5df82a47e69990f5ecc7e196961500

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page