Skip to content

Commit 418c89d

Browse files
committed
Add Placeholder man page template for flang docs
1 parent 6908ace commit 418c89d

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

flang/docs/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ if (LLVM_ENABLE_SPHINX)
129129
add_dependencies(docs-flang-html copy-flang-src-docs)
130130
endif()
131131
if (${SPHINX_OUTPUT_MAN})
132+
message(STATUS "NOTE: The Flang man page is currently a placeholder with a TODO. See docs/index.rst for details")
132133
add_sphinx_target(man flang SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/Source")
133134
add_dependencies(docs-flang-man copy-flang-src-docs)
134135
endif()

flang/docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@
231231

232232
# One entry per manual page. List of tuples
233233
# (source start file, name, description, authors, manual section).
234-
man_pages = [("index", "flang", "Flang Documentation", ["Flang Contributors"], 1)]
234+
man_pages = [("index", "flang", "Flang Documentation (In Progress)", ["Flang Contributors"], 1)]
235235

236236
# If true, show URL addresses after external links.
237237
# man_show_urls = False

flang/docs/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Flang Manual Page (In Progress)
2+
==================================================
3+
4+
.. note::
5+
This man page is under development.
6+
7+
For full documentation, please see the online HTML docs:
8+
9+
https://flang.llvm.org/docs/FlangCommandLineReference.html
10+
11+
TODO: Replace this placeholder with finalized man page content.

0 commit comments

Comments
 (0)