mirror of
https://github.com/alicevision/Meshroom.git
synced 2025-06-05 20:31:56 +02:00
[doc] sphinx documentation setup
This commit is contained in:
parent
243c278bcc
commit
b2db98f128
15 changed files with 312 additions and 73 deletions
40
docs/source/conf.py
Normal file
40
docs/source/conf.py
Normal file
|
@ -0,0 +1,40 @@
|
|||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# For the full list of built-in configuration values, see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
import sys
|
||||
|
||||
os.environ['PROJECT_DIR'] = Path('../..').resolve().as_posix()
|
||||
|
||||
sys.path.append(os.path.abspath(os.getenv('PROJECT_DIR')))
|
||||
sys.path.append(os.path.abspath('./_ext'))
|
||||
|
||||
project = 'Meshroom'
|
||||
copyright = '2022, AliceVision Association'
|
||||
author = 'AliceVision Association'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.autosummary',
|
||||
'fetch_md'
|
||||
]
|
||||
|
||||
templates_path = ['_templates']
|
||||
exclude_patterns = []
|
||||
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
html_static_path = ['_static']
|
Loading…
Add table
Add a link
Reference in a new issue