diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml index b2b2b0f12..c9cc4eda3 100644 --- a/.github/workflows/deploy-docs.yaml +++ b/.github/workflows/deploy-docs.yaml @@ -21,12 +21,8 @@ jobs: python-version: '3.x' - name: Display Python version run: python -c "import sys; print(sys.version)" - - name: Install Doxygen - run: sudo apt-get install -y doxygen - name: Install docs dependencies run: pip install -r docs/requirements.txt - - name: Build C API reference - run: cd docs && python3 generate_llapi_reference.py && cd .. - name: Build docs run: mkdocs build - uses: jakejarvis/s3-sync-action@master diff --git a/docs/requirements-llapi.txt b/docs/requirements-llapi.txt new file mode 100644 index 000000000..a0cb30875 --- /dev/null +++ b/docs/requirements-llapi.txt @@ -0,0 +1 @@ +-e git+https://github.com/matusnovak/doxybook.git#egg=doxybook diff --git a/docs/requirements.txt b/docs/requirements.txt index 3f5458890..1258a0a24 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,5 @@ mkdocs==1.0.4 mkdocs-material==4.6.3 -e git+https://github.com/RedisLabs/mkdocs-versions-menu.git#egg=mkdocs-versions-menu -e git+https://github.com/RedisLabs/mkdocs-include.git#egg=mkdocs-include --e git+https://github.com/matusnovak/doxybook.git#egg=doxybook +# uncomment requirement to build LL API +# -e git+https://github.com/matusnovak/doxybook.git#egg=doxybook diff --git a/mkdocs.yml b/mkdocs.yml index 7a3e83099..c338dc475 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,12 +33,10 @@ nav: - 'Commands': commands.md - 'Clients': clients.md - 'Configuration': configuration.md + - 'Developer': developer.md - 'Performance': performance.md - 'Examples': examples.md - 'Contributing': contrib.md - - 'Developer': - - 'Work on the code' : developer.md - - 'C API' : api_reference.md markdown_extensions: - admonition