Skip to content
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

Jump to bottom

fix: add pdf build comments for documentation #3587

Merged
merged 7 commits into from
Sep 18, 2023
Merged

fix: add pdf build comments for documentation #3587

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
673ea88
fix: add pdf comments
Revathyvenugopal162 Sep 18, 2023
222573e
Merge branch 'main' into fix/pdf-docs
Revathyvenugopal162 Sep 18, 2023
3f052f0
test: pdf commands
Revathyvenugopal162 Sep 18, 2023
eb234f6
test: pdf commands to makebad
Revathyvenugopal162 Sep 18, 2023
b15190a
fix: update the commands
Revathyvenugopal162 Sep 18, 2023
14fca06
Update .github/workflows/build_documentation.yml
Revathyvenugopal162 Sep 18, 2023
be39855
Update .github/workflows/build_documentation.yml
Revathyvenugopal162 Sep 18, 2023
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
2 changes: 1 addition & 1 deletion .github/workflows/build_documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
filter_mode: nofilter
fail_on_error: true
vale_flags: "--config=doc/.vale.ini"

Revathyvenugopal162 marked this conversation as resolved.
Show resolved Hide resolved
docs_build:
runs-on: ubuntu-20.04

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/full_documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ jobs:
- name: Create PDF Documentations
run: |
testenv\Scripts\Activate.ps1
sphinx-build -j auto --color -b pdf -a doc/source doc/_build/pdf
.\doc\make.bat pdf

- name: Upload HTML documentation artifact
uses: actions/upload-artifact@v3
Expand Down
7 changes: 7 additions & 0 deletions doc/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ set SOURCEDIR=source
set BUILDDIR=_build

if "%1" == "" goto help
if "%1" == "pdf" goto pdf

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
Expand All @@ -31,5 +32,11 @@ goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:pdf
%SPHINXBUILD% -M latex %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
cd "%BUILDDIR%\latex"
for %%f in (*.tex) do (
pdflatex "%%f" --interaction=nonstopmode)

:end
popd
Loading