Skip to main content

Create a SQLite database from Sphinx documentation

Project description

sphinx-to-sqlite

PyPI Changelog Tests License

Create a SQLite database from Sphinx documentation.

Demo

You can see the results of running this tool against the Datasette documentation at https://latest-docs.datasette.io/docs/sections

Installation

Install this tool using pip:

$ pip install sphinx-to-sqlite

Usage

First run sphinx-build with the -b xml option to create XML files in your _build/ directory.

Then run:

$ sphinx-to-sqlite docs.db path/to/_build

To build the SQLite database.

Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:

cd sphinx-to-sqlite
python -mvenv venv
source venv/bin/activate

Or if you are using pipenv:

pipenv shell

Now install the dependencies and tests:

pip install -e '.[test]'

To run the tests:

pytest

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-to-sqlite-0.1a1.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

sphinx_to_sqlite-0.1a1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-to-sqlite-0.1a1.tar.gz.

File metadata

  • Download URL: sphinx-to-sqlite-0.1a1.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0

File hashes

Hashes for sphinx-to-sqlite-0.1a1.tar.gz
Algorithm Hash digest
SHA256 9430dd4712a1d9c1e3b356743fe5f99165032de92d2f22bef82171faacb2c8e9
MD5 0e062d36064b2e5545e5def4b535a370
BLAKE2b-256 464687716620aa03b78fdba9390cc99189cdf62aee2415d6032dedb5eaca3b4e

See more details on using hashes here.

File details

Details for the file sphinx_to_sqlite-0.1a1-py3-none-any.whl.

File metadata

  • Download URL: sphinx_to_sqlite-0.1a1-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0

File hashes

Hashes for sphinx_to_sqlite-0.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 8e38eeeb52bcdee5dd39b4b4b4ef2fb68cdda38e451dc3bf4d52e1f324484fce
MD5 c1e7ed41927f1955fa7b1f3828b2a52d
BLAKE2b-256 9b44d9310472d3d13f0f248c5d77f15235cb119cab553929f9e13253643774ca

See more details on using hashes here.

Supported by

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