[PATCH] D132794: [docs] Use relative URLs for man pages
Aaron Puchert via Phabricator via llvm-commits
llvm-commits at lists.llvm.org
Sun Sep 11 11:45:53 PDT 2022
This revision was landed with ongoing or failed builds.
This revision was automatically updated to reflect the committed changes.
Closed by commit rGe4f64ad4e38d: [docs] Use relative URLs for man pages (authored by aaronpuchert).
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D132794/new/
https://reviews.llvm.org/D132794
Files:
llvm/docs/SymbolizerMarkupFormat.rst
llvm/docs/conf.py
Index: llvm/docs/conf.py
===================================================================
--- llvm/docs/conf.py
+++ llvm/docs/conf.py
@@ -236,6 +236,7 @@
man_page_authors = "Maintained by the LLVM Team (https://llvm.org/)."
command_guide_subpath = 'CommandGuide'
command_guide_path = os.path.join(basedir, command_guide_subpath)
+manpages_url = '{page}.html'
def process_md(name):
@@ -289,6 +290,3 @@
# Pygment lexer are sometimes out of date (when parsing LLVM for example) or
# wrong. Suppress the warning so the build doesn't abort.
suppress_warnings = [ 'misc.highlighting_failure' ]
-
-# Direct html-ified man pages to llvm.org
-manpages_url = 'https://llvm.org/docs/CommandGuide/{page}.html'
Index: llvm/docs/SymbolizerMarkupFormat.rst
===================================================================
--- llvm/docs/SymbolizerMarkupFormat.rst
+++ llvm/docs/SymbolizerMarkupFormat.rst
@@ -32,8 +32,8 @@
text. It's specifically intended not to require sanitizing plain text, such as
the HTML/XML requirement to replace ``<`` with ``<`` and the like.
-:manpage:`llvm-symbolizer(1)` includes a symbolizing filter via its ``--filter``
-option.
+:doc:`llvm-symbolizer <CommandGuide/llvm-symbolizer>` includes a symbolizing
+filter via its ``--filter`` option.
Scope and assumptions
=====================
@@ -431,4 +431,4 @@
.. rubric:: Footnotes
.. [#not_yet_implemented] This markup element is not yet implemented in
- :manpage:`llvm-symbolizer(1)`.
+ :doc:`llvm-symbolizer <CommandGuide/llvm-symbolizer>`.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: D132794.459384.patch
Type: text/x-patch
Size: 1541 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220911/56bfd967/attachment.bin>
More information about the llvm-commits
mailing list