Skip to main content

Sitemap generator for Sphinx

Project description

# Sphinx Sitemap Generator Extension

[Sphinx](http://sphinx-doc.org/) extension to silently generate a sitemaps.org compliant sitemap for the HTML version of your Sphinx Documentation.

[![Build Status](https://travis-ci.org/jdillard/sphinx-sitemap.svg?branch=master)](https://travis-ci.org/jdillard/sphinx-sitemap)

## 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](https://github.com/guzzle/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.1.tar.gz (2.7 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for sphinx-sitemap-0.1.tar.gz
Algorithm Hash digest
SHA256 5a57c3432a9aef88f6ca14be6da62be26221e3908130364f614ef32d7db6f6f2
MD5 c135ad1657d454f2f45c7d0b87b8a560
BLAKE2b-256 41ac3ef12d64eca3dcab976e08826c56cbe731bc7c3e5eede4e67ca440f86072

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