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

Update building docs #10064

Merged
merged 3 commits into from
Nov 3, 2024
Merged

Update building docs #10064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1003d5e
Align make.bat with Makefile for consistent documentation builds
Julfried Nov 1, 2024
96914c1
Update documentation for building the docs
Julfried Nov 1, 2024
263ed6b
Also update the help section in make.bat
Julfried Nov 2, 2024
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 doc/development_guide/contributor_guide/contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ documentation. To test smaller changes you can consider ``build-html``, which sk

$ cd doc
$ make install-dependencies
$ make build-html
$ make html

We're reusing generated files for speed, use ``make clean`` when you want to start from scratch.

Expand Down
46 changes: 29 additions & 17 deletions doc/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,38 @@ if "%1" == "" goto help

if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. linkcheck to check all external links for integrity
echo. Please use `make ^<target^>` where ^<target^> is one of:
echo.
echo. install-dependencies to install required documentation dependencies
echo. html to make standalone HTML files
echo. dirhtml to make HTML files with index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a Qt help project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an EPUB file
echo. latex to make LaTeX files (set PAPER=a4 or PAPER=letter)
echo. text to make plain text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to generate an overview of changed/added/deprecated items
echo. linkcheck to check all external links for integrity
echo. clean to remove all generated files
echo.
goto end
)


if "%1" == "install-dependencies" (
echo Installing dependencies...
cd .. && pip install -r doc/requirements.txt
goto end
)


if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
Expand Down
Loading