[flang-commits] [flang] [Flang][Docs] Add or exclude documents to the toc (PR #72302)

Kiran Chandramohan via flang-commits flang-commits at lists.llvm.org
Tue Nov 14 11:27:43 PST 2023


https://github.com/kiranchandramohan created https://github.com/llvm/llvm-project/pull/72302

This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio)
-> WARNING: document isn't included in any toctree.

>From cbf5987480055d9709db6d4c06a96a3b371ce512 Mon Sep 17 00:00:00 2001
From: Kiran Chandramohan <kiran.chandramohan at arm.com>
Date: Tue, 14 Nov 2023 19:18:08 +0000
Subject: [PATCH] [Flang][Docs] Add or exclude documents to the toc

This fixes all the warnings of the following type.
-> WARNING: document isn't included in any toctree.
---
 flang/docs/conf.py  |  2 +-
 flang/docs/index.md | 14 ++++++++++++++
 2 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/flang/docs/conf.py b/flang/docs/conf.py
index 9b4523737374705..6f4e2dd4ec87d51 100644
--- a/flang/docs/conf.py
+++ b/flang/docs/conf.py
@@ -68,7 +68,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["_build", "analyzer"]
+exclude_patterns = ["_build", "analyzer", "FIR/*"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 # default_role = None
diff --git a/flang/docs/index.md b/flang/docs/index.md
index 0e4b47995e271f4..5c9b8895298c2f3 100644
--- a/flang/docs/index.md
+++ b/flang/docs/index.md
@@ -24,6 +24,7 @@ on how to get in touch with us and to learn more about the current status.
 
    C++17
    C++style
+   DesignGuideline
    FortranForCProgrammers
    GettingInvolved
    GettingStarted
@@ -37,35 +38,48 @@ on how to get in touch with us and to learn more about the current status.
 .. toctree::
    :titlesonly:
 
+   Aliasing
+   AliasingAnalysisFIR
    ArrayComposition
    BijectiveInternalNameUniquing
    Calls
    Character
+   ComplexOperations
    ControlFlowGraph
    Directives
    DoConcurrent
    Extensions
+   F202X
+   FIRArrayOperations
    FIRLangRef
    FlangCommandLineReference
    FlangDriver
+   FortranFeatureHistory
    FortranIR
    FortranLLVMTestSuite
+   HighLevelFIR
    IORuntimeInternals
+   InternalProcedureTrampolines
    Intrinsics
    IntrinsicTypes
    LabelResolution
    ModFiles
+   OpenACC
    OpenMP-4.5-grammar.md
    OpenMP-semantics
    OptionComparison
    Overview
+   ParameterizedDerivedTypes
    ParserCombinators
    Parsing
+   PolymorphicEntities
    Preprocessing
+   ProcedurePointer
    RuntimeDescriptor
    RuntimeTypeInfo
    Semantics
    f2018-grammar.md
+   fstack-arrays
 ```
 
 # Indices and tables



More information about the flang-commits mailing list