diff options
| -rw-r--r-- | doc/man/sphinx-build.rst | 7 | ||||
| -rw-r--r-- | doc/man/sphinx-quickstart.rst | 3 | ||||
| -rw-r--r-- | doc/markup/misc.rst | 6 | ||||
| -rw-r--r-- | sphinx/environment.py | 2 |
4 files changed, 15 insertions, 3 deletions
diff --git a/doc/man/sphinx-build.rst b/doc/man/sphinx-build.rst index b8e5b272..ca493ec0 100644 --- a/doc/man/sphinx-build.rst +++ b/doc/man/sphinx-build.rst @@ -1,3 +1,5 @@ +:orphan: + sphinx-build manual page ======================== @@ -72,10 +74,9 @@ Options <sourcedir>. -C Specifies that no conf.py file at all is to be used. Configuration can only be set with the -D option. --D <setting>=<value> Overrides a setting from the configuration file. +-D <setting=value> Overrides a setting from the configuration file. -d <path> Path to cached files; defaults to <outdir>/.doctrees. --A <name>=<value> Passes a value into the HTML templates (only for HTML - builders). +-A <name=value> Passes a value into the HTML templates (only for HTML builders). -N Prevents colored output. -q Quiet operation, just prints warnings and errors on stderr. -Q Very quiet operation, doesn't print anything except for diff --git a/doc/man/sphinx-quickstart.rst b/doc/man/sphinx-quickstart.rst index 2464bcf7..17277261 100644 --- a/doc/man/sphinx-quickstart.rst +++ b/doc/man/sphinx-quickstart.rst @@ -1,3 +1,5 @@ +:orphan: + sphinx-quickstart manual page ============================= @@ -20,6 +22,7 @@ See also :manpage:`sphinx-build(1)` + Author ------ diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst index 01e5a3f1..7db403ab 100644 --- a/doc/markup/misc.rst +++ b/doc/markup/misc.rst @@ -29,6 +29,12 @@ At the moment, these metadata fields are recognized: If set, the web application won't display a comment form for a page generated from this source file. +``orphan`` + If set, warnings about this file not being included in any toctree will be + suppressed. + + .. versionadded:: 1.0 + Meta-information markup ----------------------- diff --git a/sphinx/environment.py b/sphinx/environment.py index dacec2c1..ad6d6ea8 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -1549,4 +1549,6 @@ class BuildEnvironment: if docname == self.config.master_doc: # the master file is not included anywhere ;) continue + if 'orphan' in self.metadata[docname]: + continue self.warn(docname, 'document isn\'t included in any toctree') |