notfound.extension.OrphanMetadataCollector Class Reference

Inheritance diagram for notfound.extension.OrphanMetadataCollector:

Collaboration diagram for notfound.extension.OrphanMetadataCollector:

Public Member Functions
	clear_doc (self, app, env, docname)
	process_doc (self, app, doctree)
	merge_other (self, app, env, docnames, other)
Public Member Functions inherited from sphinx.environment.collectors.EnvironmentCollector
None	enable (self, Sphinx app)
None	disable (self, Sphinx app)
list[str]	get_updated_docs (self, Sphinx app, BuildEnvironment env)
list[str]	get_outdated_docs (self, Sphinx app, BuildEnvironment env, set[str] added, set[str] changed, set[str] removed)

Additional Inherited Members
Public Attributes inherited from sphinx.environment.collectors.EnvironmentCollector
	listener_ids
	get_updated_docs
	get_outdated_docs
Static Public Attributes inherited from sphinx.environment.collectors.EnvironmentCollector
dict	listener_ids = None

Detailed Description

Force the 404 page to be ``orphan``.

This way we remove the WARNING that Sphinx raises saying the page is not
included in any toctree.

This collector has the same effect than ``:orphan:`` at the top of the page.

Member Function Documentation

clear_doc()

notfound.extension.OrphanMetadataCollector.clear_doc	(		self,
			app,
			env,
			docname
	)

Remove specified data of a document.

This method is called on the removal of the document.

Reimplemented from sphinx.environment.collectors.EnvironmentCollector.

merge_other()

notfound.extension.OrphanMetadataCollector.merge_other	(		self,
			app,
			env,
			docnames,
			other
	)

Merge in specified data regarding docnames from a different `BuildEnvironment`
object which coming from a subprocess in parallel builds.

Reimplemented from sphinx.environment.collectors.EnvironmentCollector.

process_doc()

notfound.extension.OrphanMetadataCollector.process_doc	(		self,
			app,
			doctree
	)

Process a document and gather specific data from it.

This method is called after the document is read.

Reimplemented from sphinx.environment.collectors.EnvironmentCollector.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/notfound/extension.py