Skip to content

Commit 4e4f04f

Browse files
authored
Update building docs (#10064)
* Align make.bat with Makefile for consistent documentation builds * Update documentation for building the docs * Also update the help section in make.bat
1 parent 15a5ac0 commit 4e4f04f

File tree

2 files changed

+30
-18
lines changed

2 files changed

+30
-18
lines changed

doc/development_guide/contributor_guide/contribute.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ documentation. To test smaller changes you can consider ``build-html``, which sk
130130

131131
$ cd doc
132132
$ make install-dependencies
133-
$ make build-html
133+
$ make html
134134

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

doc/make.bat

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,38 @@ if "%1" == "" goto help
1515

1616
if "%1" == "help" (
1717
:help
18-
echo.Please use `make ^<target^>` where ^<target^> is one of
19-
echo. html to make standalone HTML files
20-
echo. dirhtml to make HTML files named index.html in directories
21-
echo. singlehtml to make a single large HTML file
22-
echo. pickle to make pickle files
23-
echo. json to make JSON files
24-
echo. htmlhelp to make HTML files and a HTML help project
25-
echo. qthelp to make HTML files and a qthelp project
26-
echo. devhelp to make HTML files and a Devhelp project
27-
echo. epub to make an epub
28-
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
29-
echo. text to make text files
30-
echo. man to make manual pages
31-
echo. texinfo to make Texinfo files
32-
echo. gettext to make PO message catalogs
33-
echo. changes to make an overview over all changed/added/deprecated items
34-
echo. linkcheck to check all external links for integrity
18+
echo. Please use `make ^<target^>` where ^<target^> is one of:
19+
echo.
20+
echo. install-dependencies to install required documentation dependencies
21+
echo. html to make standalone HTML files
22+
echo. dirhtml to make HTML files with index.html in directories
23+
echo. singlehtml to make a single large HTML file
24+
echo. pickle to make pickle files
25+
echo. json to make JSON files
26+
echo. htmlhelp to make HTML files and a HTML help project
27+
echo. qthelp to make HTML files and a Qt help project
28+
echo. devhelp to make HTML files and a Devhelp project
29+
echo. epub to make an EPUB file
30+
echo. latex to make LaTeX files (set PAPER=a4 or PAPER=letter)
31+
echo. text to make plain text files
32+
echo. man to make manual pages
33+
echo. texinfo to make Texinfo files
34+
echo. gettext to make PO message catalogs
35+
echo. changes to generate an overview of changed/added/deprecated items
36+
echo. linkcheck to check all external links for integrity
37+
echo. clean to remove all generated files
38+
echo.
3539
goto end
3640
)
3741

42+
43+
if "%1" == "install-dependencies" (
44+
echo Installing dependencies...
45+
cd .. && pip install -r doc/requirements.txt
46+
goto end
47+
)
48+
49+
3850
if "%1" == "clean" (
3951
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
4052
del /q /s %BUILDDIR%\*

0 commit comments

Comments
 (0)