oct_docs.py File Reference

Go to the source code of this file.

Namespaces
namespace	oct
namespace	oct.docs
namespace	oct.docs.oct_docs

Functions
bool	oct.docs.oct_docs._is_auto_generated (Path path, str marker)
list[str]	oct.docs.oct_docs._check_sphinx_deps ()
dict	oct.docs.oct_docs._load_project_info (Path root)
dict	oct.docs.oct_docs._load_docs_config (Path root)
list[str]	oct.docs.oct_docs._discover_markdown (Path docs_dir)
list[str]	oct.docs.oct_docs._order_markdown (list[str] stems)
bool	oct.docs.oct_docs._should_skip_dir (Path path, Path root)
list[tuple[str, Path]]	oct.docs.oct_docs._find_packages (Path root, dict config)
bool	oct.docs.oct_docs._generate_api_rst (Path root, Path docs_dir, dict config)
bool	oct.docs.oct_docs._generate_deps_rst (Path root, Path docs_dir)
None	oct.docs.oct_docs._write_index_rst (Path docs_dir, str project_name, list[str] md_stems, bool has_api, bool has_deps)
Path	oct.docs.oct_docs.setup_sphinx (Path root)
int	oct.docs.oct_docs.run_sphinx_build (Path docs_dir, dict config)
int	oct.docs.oct_docs.run_docs_sphinx (Path root)
bool	oct.docs.oct_docs._check_doxygen_installed ()
Path|None	oct.docs.oct_docs._find_doxyfile (Path root)
Path	oct.docs.oct_docs._create_patched_doxyfile (Path doxyfile_path, Path root)
int	oct.docs.oct_docs._sweep_stale_doxyfiles (int max_age_seconds=_STALE_DOXYFILE_MAX_AGE_SECONDS)
int	oct.docs.oct_docs.run_docs_doxygen (Path root)
int	oct.docs.oct_docs.run_docs_clean (Path root, *, bool dry_run=False)
int	oct.docs.oct_docs.run_docs_all (Path root)

Variables
str	oct.docs.oct_docs._TEMPLATES_DIR = Path(__file__).parent.parent / "templates" / "sphinx"
str	oct.docs.oct_docs._AUTO_MARKER_RST = ".. Auto-generated by oct docs --sphinx"
str	oct.docs.oct_docs._AUTO_MARKER_MD = "<!-- Auto-generated by oct docs --sphinx -->"
list	oct.docs.oct_docs._REQUIRED_PACKAGES
dict	oct.docs.oct_docs._DOCS_EXCLUDE_DIRS
list	oct.docs.oct_docs._PRIORITY_DOCS
int	oct.docs.oct_docs._MAX_PACKAGE_DEPTH = 10
int	oct.docs.oct_docs._STALE_DOXYFILE_MAX_AGE_SECONDS = 24 * 60 * 60
list	oct.docs.oct_docs._DOCS_CLEAN_DIRS = ["html", "doctrees", "_api", "doxygen_output"]
list	oct.docs.oct_docs._DOCS_CLEAN_FILES = ["index.rst", "dependencies.rst"]