Skip to content

Commit 4101933

Browse files
authored
Merge pull request #526 from chaen/doc_review_admin
Actually Write the admin doc
2 parents 810af65 + e8554f7 commit 4101933

File tree

3 files changed

+4
-10
lines changed

3 files changed

+4
-10
lines changed

docs/dev/explanations/components/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The `diracx-cli` is a command-line interface built on `diracx-client` and `dirac
66

77
CLI commands are located in `diracx-cli/src/diracx/cli/`. To create a CLI command:
88

9-
1. Import `AsyncDiracClient` and/or the diracx API.
9+
1. Import `AsyncDiracClient` and/or `diracx-api`.
1010
2. Import `utils.AsyncTyper`.
1111
3. Use the `@app.async_command` decorator to define commands.
1212

docs/dev/tutorials/run-locally.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Run a full diracx demo
1+
## Run a full DiracX demo
22

33
TODO: expand
44

mkdocs.yml

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,32 +69,26 @@ nav:
6969
- Consortium: project/consortium.md
7070

7171
markdown_extensions:
72+
- admonition
7273
- def_list
7374
- pymdownx.tasklist:
7475
custom_checkbox: true
7576
- attr_list
7677
- pymdownx.emoji:
7778
emoji_index: !!python/name:material.extensions.emoji.twemoji
7879
emoji_generator: !!python/name:material.extensions.emoji.to_svg
80+
- pymdownx.details
7981
- pymdownx.superfences:
8082
custom_fences:
8183
- name: mermaid
8284
class: mermaid
8385
format: !!python/name:pymdownx.superfences.fence_code_format
84-
- pymdownx.highlight:
85-
anchor_linenums: true
86-
line_spans: __span
87-
pygments_lang_class: true
8886
- pymdownx.inlinehilite
8987
- pymdownx.snippets
90-
- pymdownx.superfences
9188
- pymdownx.highlight:
9289
anchor_linenums: true
9390
line_spans: __span
9491
pygments_lang_class: true
95-
- pymdownx.inlinehilite
96-
- pymdownx.snippets
97-
- pymdownx.superfences
9892
- tables
9993

10094
plugins:

0 commit comments

Comments
 (0)