You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
e3b0303376 | 1 year ago | |
---|---|---|
.github | 1 year ago | |
docs | 1 year ago | |
src/doc_search | 1 year ago | |
tests | 1 year ago | |
.flake8 | 1 year ago | |
.gitignore | 1 year ago | |
.pre-commit-config.yaml | 1 year ago | |
CHANGELOG.md | 1 year ago | |
LICENCE | 1 year ago | |
Makefile | 1 year ago | |
README.md | 1 year ago | |
mkdocs.yml | 1 year ago | |
poetry.lock | 1 year ago | |
poetry.toml | 1 year ago | |
pyproject.toml | 1 year ago | |
setup.cfg | 1 year ago |
README.md
Doc Search
Documentation: https://namuan.github.io/dr-doc-search
Source Code: https://github.com/namuan/dr-doc-search
PyPI: https://pypi.org/project/dr-doc-search/
Converse with an ebook (PDF)
Pre-requisites
Installation
pip install dr-doc-search
Example Usage
dr-doc-search --help
Development
-
Clone this repository
-
Requirements:
- Python 3.7+
- Poetry
-
Create a virtual environment and install the dependencies
poetry install
- Activate the virtual environment
poetry shell
Validating build
make build
Release process
A release is automatically published when a new version is bumped using make bump
.
See .github/workflows/build.yml
for more details.
Once the release is published, .github/workflows/publish.yml
will automatically publish it to PyPI.