diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index a013043b..ec42cf31 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -32,7 +32,7 @@ jobs: - name: Build documentation working-directory: ./docs - run: make clean && make html O="-W --keep-going" + run: make clean && make html_all O="-W --keep-going" - name: Upload built doc uses: actions/upload-artifact@v2 diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml index b58ad299..15c2e1f5 100644 --- a/.github/workflows/docs-deploy.yml +++ b/.github/workflows/docs-deploy.yml @@ -2,8 +2,8 @@ name: Deploy Documentation on: push: -# branches: -# - master + branches: + - master jobs: deploy: diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..e7ac30db --- /dev/null +++ b/docs/README.md @@ -0,0 +1,38 @@ +## Requirements + +In order to generate the documentation, it is necessary to have a Python environment with the +following: +```python +pip install sphinx sphinx_rtd_theme setuptools_rust +``` + +It is also necessary to have the `tokenizers` library in this same environment, for Sphinx to +generate all the API Reference and links properly. If you want to visualize the documentation with +some modifications made to the Python bindings, make sure you build it from source. + +## Building the documentation + +Once everything is setup, you can build the documentation automatically for all the languages +using the following command in the `/docs` folder: + +```bash +make html_all +``` + +If you want to build only for a specific language, you can use: + +```bash +make html O="-t python" +``` + +(Replacing `python` by the target language among `rust`, `node`, and `python`) + + +**NOTE** + +If you are making any structural change to the documentation, it is recommended to clean the build +directory before rebuilding: + +```bash +make clean && make html_all +```