Skip to content

[WIP] add C API reference to docs using auto tool #368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 20, 2020
Merged

[WIP] add C API reference to docs using auto tool #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e572464
[add] add C API reference to docs using auto tool ( python3 generate_…
filipecosta90 May 8, 2020
4b626ae
[add] generating C API reference on the fly
filipecosta90 May 20, 2020
95e7fce
Merge remote-tracking branch 'origin/master' into c_api
filipecosta90 May 20, 2020
2f16308
[add] moving api_reference under Developer Nav
filipecosta90 May 20, 2020
8e805cc
Merge branch 'master' into c_api
lantiga May 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/deploy-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,12 @@ jobs:
python-version: '3.x'
- name: Display Python version
run: python -c "import sys; print(sys.version)"
- name: Install Doxygen
run: 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
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ venv*/
*.tar.gz
/VARIANT

# Docs API reference
docs/api_reference.md

### Cmake auto tools
cmake-build-debug

Expand Down
Loading