我正在尝试使用以下方法生成自动化文档:
mkdocs = "^1.4.2"
mkdocstrings = "0.19.0"
mkdocs-material = "8.5.8"
mkdocstrings-python = "0.7.1"
我的 mkdocs.yml 看起来像这样:
site_name: Optimization Services Documentation
site_url: "https://example.com"
theme:
name: "material"
nav:
- 'index.md'
- 'reference.md'
plugins:
- search
- mkdocstrings:
handlers:
python:
setup_commands:
- import sys
- sys.path.append('../')
selection:
new_path_syntax: true
Run Code Online (Sandbox Code Playgroud)
index.md 仍然是 mkdocs new 生成的默认文件。
Reference.md 看起来像这样:
# Reference
::: modelling.constraints
Run Code Online (Sandbox Code Playgroud)
和 modelling.constraints.py:
def init_constraints(groupes_chantiers: list[GroupeChantiers],
digraph_precedence: nx.DiGraph,
graph_coactivite: nx.Graph,
model: cp_model.CpModel,
**kwargs) -> None:
"""
Adds constraints to cp_model
Args:
groupes_chantiers:
digraph_precedence:
graph_coactivite: …Run Code Online (Sandbox Code Playgroud)