Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-11 17:14:41 +00:00
Code Issues Releases Activity

doc/make: Build main doc target by default.

Browse Source 
Less typing is better.
This commit is contained in:
Laurens Valk
2021-07-23 15:46:58 +02:00
parent cb74f8e302
commit 84335d0032
3 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+3 -3
View File
@@ -61,15 +61,15 @@ Initial setup:
Build docs:
# Linux
poetry run make -C doc html SPHINXOPTS=-tmain
poetry run make -C doc html
xdg-open doc/main/build/html/index.html
# macOS
poetry run make -C doc html SPHINXOPTS=-tmain
poetry run make -C doc html
open doc/main/build/html/index.html
# Windows (PowerShell)
poetry run doc\make.bat html SPHINXOPTS=-tmain
poetry run doc\make.bat html
Invoke-Item doc\main\build\html\index.html
Linting:
doc/Makefile
+1 -1
View File
@@ -2,7 +2,7 @@
#
# You can set these variables from the command line.
SPHINXOPTS = -W
SPHINXOPTS = -W -tmain
SPHINXBUILD = sphinx-build
SPHINXPROJ = Pybricks
SOURCEDIR = main
doc/make.bat
+1 -1
View File
@@ -7,7 +7,7 @@ REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SPHINXOPTS=-W
set SPHINXOPTS=-W -tmain
set SOURCEDIR=main
set BUILDDIR=%SOURCEDIR%/build
set SPHINXPROJ=Pybricks