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
pylint-dev · Nov 3, 2024 · 4e4f04f · 4e4f04f
1 parent 15a5ac0
commit 4e4f04f
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 18 deletions.
diff --git a/doc/development_guide/contributor_guide/contribute.rst b/doc/development_guide/contributor_guide/contribute.rst
@@ -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.
 

diff --git a/doc/make.bat b/doc/make.bat
@@ -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%\*