Skip to content

Commit 1ea3e3d

Browse files
committed
docs: include library reference
1 parent f555ee1 commit 1ea3e3d

File tree

6 files changed

+560
-81
lines changed

6 files changed

+560
-81
lines changed

bootstrap.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2378,13 +2378,19 @@ def generate_run_configs(self):
23782378
"name": "MrDocs Build Local Docs",
23792379
"script": os.path.join(mrdocs_docs_dir, f"build_local_docs.{mrdocs_docs_script_ext}"),
23802380
"args": [],
2381-
"cwd": mrdocs_docs_dir
2381+
"cwd": mrdocs_docs_dir,
2382+
"env": {
2383+
"MRDOCS_ROOT": self.options.mrdocs_install_dir
2384+
}
23822385
})
23832386
configs.append({
23842387
"name": "MrDocs Build Docs",
23852388
"script": os.path.join(mrdocs_docs_dir, f"build_docs.{mrdocs_docs_script_ext}"),
23862389
"args": [],
2387-
"cwd": mrdocs_docs_dir
2390+
"cwd": mrdocs_docs_dir,
2391+
"env": {
2392+
"MRDOCS_ROOT": self.options.mrdocs_install_dir
2393+
}
23882394
})
23892395
configs.append({
23902396
"name": "MrDocs Build UI Bundle",

docs/antora-playbook.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ antora:
4040
start_on_load: true
4141
- require: '@antora/lunr-extension' # https://gitlab.com/antora/antora-lunr-extension
4242
index_latest_only: true
43+
- require: '@cppalliance/antora-cpp-reference-extension'
4344

4445
asciidoc:
4546
attributes:

docs/antora.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,6 @@ asciidoc:
1010
table-caption: false
1111
nav:
1212
- modules/ROOT/nav.adoc
13+
ext:
14+
cpp-reference:
15+
config: docs/mrdocs.yml

docs/modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@
66
* xref:commands.adoc[Documenting the Code]
77
* xref:generators.adoc[]
88
* xref:design-notes.adoc[]
9+
* xref:reference:index.adoc[Library Reference]
910
* xref:contribute.adoc[]
1011
* xref:license.adoc[]

0 commit comments

Comments
 (0)