DOC generator for language learning
Project description
Installation
pip3 install --verbose linguadoc
Usage
Please refer to api docs.
Execute usage
- Convert json into docx
gen_lingua_docx --sourcejson [source.json] --lang [en/de/es] --destdocx [output.docx] --title [test_title]
Package usage
Development
Clone project
git clone https://github.com/qishe-nlp/linguadoc.git
Install poetry
Install dependencies
poetry update
Test
poetry run pytest -rP --capture=sys
which run tests under tests/*
Execute
poetry run gen_lingua_docx --help
Create sphinx docs
poetry shell
cd apidocs
sphinx-apidoc -f -o source ../linguadoc
make html
python -m http.server -d build/html
Host docs on github pages
cp -rf apidocs/build/html/* docs/
Build
- Change
version
inpyproject.toml
andlinguadoc/__init__.py
- Build python package by
poetry build
Git commit and push
Publish from local dev env
- Set pypi test environment variables in poetry, refer to poetry doc
- Publish to pypi test by
poetry publish -r test
Publish through CI
- Github action build and publish package to test pypi repo
git tag [x.x.x]
git push origin master
- Manually publish to pypi repo through github action
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
linguadoc-0.1.1.tar.gz
(1.3 MB
view hashes)
Built Distribution
Close
Hashes for linguadoc-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e5d06ccae682606508e4f29bbee956afa1d9acbdcbfc27589de328eb3350927 |
|
MD5 | f11f5058dc1e854efa2eaf44f25b6f21 |
|
BLAKE2b-256 | f1e7315d1a5ff85515fbbb49fa1e985e82a1013fba6d79c258c22f042884b973 |