Skip to content

Commit f3ceef4

Browse files
committed
Add to-do to the documentation
1 parent 9feb1c0 commit f3ceef4

File tree

2 files changed

+3
-9
lines changed

2 files changed

+3
-9
lines changed

docs/index.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,7 @@
33
MQT NAViz is an open-source Rust and Python library to visualize atom movements of neutral atom quantum computers.
44
It is developed as part of the _{doc}`Munich Quantum Toolkit (MQT) <mqt:index>`_ by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de).
55

6-
:::{note}
7-
8-
The documentation of MQT NAViz is still under construction.
9-
We appreciate any help with this task.
10-
For now, please refer to the API documentation linked on the left.
11-
For format specifications for `.namachine`, `.nastyle` and input files, refer to {ref}`file_format`.
12-
13-
:::
6+
TODO.
147

158
```{toctree}
169
:hidden:
@@ -23,6 +16,7 @@ self
2316
:caption: User Guide
2417
:hidden:
2518
19+
usage
2620
file_format
2721
```
2822

docs/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
NAViz allows opening `.naviz` instruction files or importing instructions from external formats such as `mqt na` under the `File` menu.
66
Alternatively, files can simply be dropped onto or pasted into the application.
7-
You can read more about the supported file formats in the {doc}`file format documentation <file_format>`.
7+
For more information on the supported file formats, see {doc}`file_format`.
88

99
The machine and style can be selected from the `Machine` and `Style` menus respectively.
1010
These menus allow selecting a config from the loaded configs as well as opening or importing a new config.

0 commit comments

Comments
 (0)