pypi_packages: sphinx-to-sqlite
This data as json
name | summary | classifiers | description | author | author_email | description_content_type | home_page | keywords | license | maintainer | maintainer_email | package_url | platform | project_url | project_urls | release_url | requires_dist | requires_python | version | yanked | yanked_reason |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sphinx-to-sqlite | Create a SQLite database from Sphinx documentation | [] | # sphinx-to-sqlite [](https://pypi.org/project/sphinx-to-sqlite/) [](https://github.com/simonw/sphinx-to-sqlite/releases) [](https://github.com/simonw/sphinx-to-sqlite/actions?query=workflow%3ATest) [](https://github.com/simonw/sphinx-to-sqlite/blob/master/LICENSE) Create a SQLite database from Sphinx documentation. ## Demo You can see the results of running this tool against the [Datasette documentation](https://docs.datasette.io/) 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 | Simon Willison | text/markdown | https://github.com/simonw/sphinx-to-sqlite | Apache License, Version 2.0 | https://pypi.org/project/sphinx-to-sqlite/ | https://pypi.org/project/sphinx-to-sqlite/ | {"CI": "https://github.com/simonw/sphinx-to-sqlite/actions", "Changelog": "https://github.com/simonw/sphinx-to-sqlite/releases", "Homepage": "https://github.com/simonw/sphinx-to-sqlite", "Issues": "https://github.com/simonw/sphinx-to-sqlite/issues"} | https://pypi.org/project/sphinx-to-sqlite/0.1a1/ | ["click", "sqlite-utils", "pytest ; extra == 'test'"] | 0.1a1 | 0 |