Skip to content

[lldb][man][nfc] Don't register a markdown parser when building man packages #98420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 11, 2024

Conversation

alanzhao1
Copy link
Contributor

This reduces Sphinx dependencies for building lldb man pages as lldb man pages don't use markdown.

…ages

This reduces Sphinx dependencies for building lldb man pages as lldb man
pages don't use markdown.
@llvmbot
Copy link
Member

llvmbot commented Jul 11, 2024

@llvm/pr-subscribers-lldb

Author: Alan Zhao (alanzhao1)

Changes

This reduces Sphinx dependencies for building lldb man pages as lldb man pages don't use markdown.


Full diff: https://github.com/llvm/llvm-project/pull/98420.diff

1 Files Affected:

  • (modified) lldb/docs/conf.py (+5-1)
diff --git a/lldb/docs/conf.py b/lldb/docs/conf.py
index 27a1cd7c3c31a..805a6dc19ac81 100644
--- a/lldb/docs/conf.py
+++ b/lldb/docs/conf.py
@@ -89,9 +89,13 @@
 # The suffix of source filenames.
 source_suffix = {
     ".rst": "restructuredtext",
-    ".md": "markdown",
 }
 
+# Man pages do not use markdown pages, so we don't need to register a markdown
+# parser.
+if not building_man_page:
+  source_suffix[".md"] = "markdown"
+
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 

Copy link

github-actions bot commented Jul 11, 2024

✅ With the latest revision this PR passed the Python code formatter.

Copy link
Collaborator

@DavidSpickett DavidSpickett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me just a minor comment on placement.

@alanzhao1 alanzhao1 merged commit 43024a4 into llvm:main Jul 11, 2024
5 of 6 checks passed
@alanzhao1 alanzhao1 deleted the feature/lldb-man-no-md branch July 11, 2024 19:54
aaryanshukla pushed a commit to aaryanshukla/llvm-project that referenced this pull request Jul 14, 2024
…ackages (llvm#98420)

This reduces Sphinx dependencies for building lldb man pages as lldb man
pages don't use markdown.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants