Skip to contentSkip to conversation

Makefile: List the sphinx documentation in 'make help'

PATCH In review Philippe Mathieu-Daudé 3 participants 4 messages Jan 22, 2020 – Jan 23, 2020 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Makefile: List the sphinx documentation in 'make help'

In commit 5f71eac06e1 we started to support the rST documentation. List the build target we need to call to generate the rST files in the 'make help' output.

---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Makefile +1 -1
index 6562b0dc97..b777f7fcdd 100644
@@ -1197,7 +1197,7 @@ endif
 	@echo  '  vm-help         - Help about targets running tests inside VM'
 	@echo  ''
 	@echo  'Documentation targets:'
-	@echo  '  html info pdf txt'
+	@echo  '  html info pdf txt sphinxdocs'
 	@echo  '                  - Build documentation in specified format'
 ifdef CONFIG_GCOV
 	@echo  '  coverage-report - Create code coverage report'
Signature · 1 line
2.21.1
#2 lore raw
In reply to Philippe Mathieu-Daudé
Quoted 15 lines · Philippe Mathieu-Daudé

In commit 5f71eac06e1 we started to support the rST documentation. List the build target we need to call to generate the rST files in the 'make help' output.

---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Makefile +0 -0
index 6562b0dc97..b777f7fcdd 100644

Makefile endif · line 1203

Quoted 8 lines
Makefile +1 -1
@@ -1197,7 +1197,7 @@ endif
        @echo  '  vm-help         - Help about targets running tests inside VM'
        @echo  ''
        @echo  'Documentation targets:'
-       @echo  '  html info pdf txt'
+       @echo  '  html info pdf txt sphinxdocs'
        @echo  '                  - Build documentation in specified format'
 ifdef CONFIG_GCOV
        @echo  '  coverage-report - Create code coverage report'

'sphinxdocs' wasn't intended to be a user-facing target. If you do 'make html' this will build the HTML Sphinx documentation (as well as any legacy non-Sphinx HTML).

thanks
-- PMM

#3 lore raw
Quoted 20 lines · Peter Maydell
Quoted 19 lines · Philippe Mathieu-Daudé

In commit 5f71eac06e1 we started to support the rST documentation. List the build target we need to call to generate the rST files in the 'make help' output.

---
  Makefile | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Makefile +0 -1
index 6562b0dc97..b777f7fcdd 100644
@@ -1197,7 +1197,7 @@ endif
         @echo  '  vm-help         - Help about targets running tests inside VM'
         @echo  ''
         @echo  'Documentation targets:'
-       @echo  '  html info pdf txt'
Quoted 8 lines

Makefile endif · line 1203

Quoted 4 lines
Makefile +1 -0
+       @echo  '  html info pdf txt sphinxdocs'
         @echo  '                  - Build documentation in specified format'
  ifdef CONFIG_GCOV
         @echo  '  coverage-report - Create code coverage report'

'sphinxdocs' wasn't intended to be a user-facing target. If you do 'make html' this will build the HTML Sphinx documentation (as well as any legacy non-Sphinx HTML).

Ah OK! I guess I didn't read enough the documentation then :/