From 39d43b06937987e7ee3b095e31881161654ba3cd Mon Sep 17 00:00:00 2001 From: filipecosta90 Date: Wed, 20 May 2020 15:22:43 +0100 Subject: [PATCH 1/3] [fix] fixed doxygen install --- .github/workflows/deploy-docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml index da430c18e..b2b2b0f12 100644 --- a/.github/workflows/deploy-docs.yaml +++ b/.github/workflows/deploy-docs.yaml @@ -22,7 +22,7 @@ jobs: - name: Display Python version run: python -c "import sys; print(sys.version)" - name: Install Doxygen - run: apt-get install -y doxygen + run: sudo apt-get install -y doxygen - name: Install docs dependencies run: pip install -r docs/requirements.txt - name: Build C API reference From 74249018f411604d19f9a5b0780e4a92609cb92e Mon Sep 17 00:00:00 2001 From: filipecosta90 Date: Sat, 23 May 2020 22:36:27 +0100 Subject: [PATCH 2/3] [add] removing LL API from docs but keeping the automation to generate it locally --- .github/workflows/deploy-docs.yaml | 4 ---- docs/requirements.txt | 3 ++- mkdocs.yml | 6 ++---- 3 files changed, 4 insertions(+), 9 deletions(-) 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.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..7904a0846 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,13 +33,11 @@ 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 - pymdownx.arithmatex From e6d9e7709e98878ae8414451ae5ee43d99fce13b Mon Sep 17 00:00:00 2001 From: filipecosta90 Date: Mon, 25 May 2020 12:01:22 +0100 Subject: [PATCH 3/3] [fix] fix per PR review --- docs/requirements-llapi.txt | 1 + mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 docs/requirements-llapi.txt 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/mkdocs.yml b/mkdocs.yml index 7904a0846..c338dc475 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -37,7 +37,7 @@ nav: - 'Performance': performance.md - 'Examples': examples.md - 'Contributing': contrib.md - + markdown_extensions: - admonition - pymdownx.arithmatex