Create a SQLite database from Sphinx documentation
Project description
sphinx-to-sqlite
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
Release history Release notifications | RSS feed
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 hashes)
Built Distribution
Close
Hashes for sphinx_to_sqlite-0.1a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e38eeeb52bcdee5dd39b4b4b4ef2fb68cdda38e451dc3bf4d52e1f324484fce |
|
MD5 | c1e7ed41927f1955fa7b1f3828b2a52d |
|
BLAKE2b-256 | 9b44d9310472d3d13f0f248c5d77f15235cb119cab553929f9e13253643774ca |