Skip to content

Commit 57f99f6

Browse files
authored
Add the supported-targets page (#88)
The page contains a table for all different loaders, containers, partition schemes, volume systems, filesystems, operating systems and child targets that Dissect supports.
1 parent 6a5cbe8 commit 57f99f6

File tree

4 files changed

+427
-13
lines changed

4 files changed

+427
-13
lines changed

docs/source/conf.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,9 @@
7373
api_dir = Path(__file__).parent / "api"
7474

7575
for dir_name in ["acquire/nop", "dissect/nop", "flow/nop"]:
76-
api_dir.joinpath(dir_name).mkdir(parents=True, exist_ok=True)
77-
api_dir.joinpath(dir_name, "index.rst").write_text(":orphan:\n\nTITLE\n#####\n")
76+
if not (nop_dir := api_dir.joinpath(dir_name)).exists():
77+
nop_dir.mkdir(parents=True, exist_ok=True)
78+
nop_dir.joinpath("index.rst").write_text(":orphan:\n\nTITLE\n#####\n")
7879

7980
else:
8081
extensions.append("autoapi.extension")

docs/source/index.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ Usage Example
1818
-------------
1919

2020
One of the most prominent tools that Dissect offers is called *target-query*.
21-
With this simple command you can, for example, extract all user accounts from a disk image:
21+
With this simple command you can, for example, extract all user accounts from a disk image:
2222

2323
.. code-block:: console
2424
2525
$ target-query pc.img -f users
26-
26+
2727
<windows/user ... name='systemprofile' ...>
2828
<windows/user ... name='LocalService' ...>
2929
<windows/user ... name='NetworkService' ...>
3030
<windows/user ... name='Mr. Evil' ...>
31-
31+
3232
To see what other useful artefacts you can query use ``-l``:
3333

3434
.. code-block:: console
@@ -80,31 +80,31 @@ Or you can start by taking a look at some community articles and videos:
8080
:doc:`/resources/dissect-in-action` or
8181
:doc:`/resources/talks-and-conferences` to begin with.
8282

83-
Get in touch, join us on `github <https://github.com/fox-it/dissect.target>`_!
83+
Get in touch, join us on `GitHub <https://github.com/fox-it/dissect>`_!
8484

8585

8686
.. toctree::
8787
:hidden:
88-
88+
8989
Home <self>
9090

9191
.. toctree::
9292
:caption: Basics
9393
:hidden:
9494

95-
Install </install>
96-
Tutorial </tutorial>
95+
/install
96+
/supported-targets
97+
/tutorial
9798
Querying </target-query>
9899
Shell </target-shell>
99100
Mount </target-mount>
100101
Acquire </acquire>
101102
RDump </rdump>
102-
103-
103+
104104
.. toctree::
105105
:caption: In-Depth
106106
:hidden:
107-
107+
108108
/tools/index
109109
/projects/index
110110
/usage/index

0 commit comments

Comments
 (0)