gallo/atrip
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Put doxygen in sphinx

Browse Source
This commit is contained in:
Alejandro Gallo 2022-03-10 15:00:08 +01:00
parent 93ea08db81
commit 50cc81772c
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.github/workflows/main.yml vendored
View File

@ -67,13 +67,8 @@ jobs:
cd docs cd docs
nix-shell --run 'make sphinx' nix-shell --run 'make sphinx'
- name: Make sphinx as the main page
run: |
cd docs
mv sphinx/* .
- name: Deploy - name: Deploy
uses: JamesIves/github-pages-deploy-action@4.1.0 uses: JamesIves/github-pages-deploy-action@4.1.0
with: with:
branch: gh-pages branch: gh-pages
folder: ./docs folder: ./docs/build

2
docs/Doxyfile
View File

@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If # entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used. # left blank the current directory will be used.
OUTPUT_DIRECTORY = doxygen OUTPUT_DIRECTORY = build/doxygen
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and # directories (in 2 levels) under the output directory of each output format and

9
docs/Makefile
View File

@ -1,14 +1,19 @@
DOXYGEN_INDEX = doxygen/html/index.html # variables
#
SPHINX_BUILD_DIR = build
DOXYGEN_INDEX = $(SPHINX_BUILD_DIR)/doxygen/html/index.html
# rules
#
all: doxygen sphinx all: doxygen sphinx
.PHONY: sphinx doxygen .PHONY: sphinx doxygen
doxygen: $(DOXYGEN_INDEX) doxygen: $(DOXYGEN_INDEX)
$(DOXYGEN_INDEX): $(DOXYGEN_INDEX):
mkdir -p $(@D)
doxygen Doxyfile doxygen Doxyfile
SPHINX_BUILD_DIR = sphinx
$(SPHINX_BUILD_DIR)/index.html: index.rst atrip.rst conf.py $(SPHINX_BUILD_DIR)/index.html: index.rst atrip.rst conf.py
sphinx-build . $(SPHINX_BUILD_DIR) sphinx-build . $(SPHINX_BUILD_DIR)
sphinx: $(SPHINX_BUILD_DIR)/index.html sphinx: $(SPHINX_BUILD_DIR)/index.html