https://github.com/fox-it/dissect-docs
Dissect documentation project
https://github.com/fox-it/dissect-docs
Last synced: 12 months ago
JSON representation
Dissect documentation project
- Host: GitHub
- URL: https://github.com/fox-it/dissect-docs
- Owner: fox-it
- License: agpl-3.0
- Created: 2022-07-13T08:11:04.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-06-27T11:06:20.000Z (12 months ago)
- Last Synced: 2025-06-27T12:24:36.596Z (12 months ago)
- Size: 320 KB
- Stars: 8
- Watchers: 10
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dissect documentation
This project houses the Sphinx documentation for the Dissect project.
## Build and instructions
Start by checking out the submodules if you haven't done so already:
```bash
git submodule update --init --recursive
```
If you want to update all submodules add `--remote` to the previous command.
Create a new virtual environment, install the dependencies and build the Sphinx project.
```bash
pip install -r requirements.txt
cd docs && make html
```
If you run into build issues, clean the Sphinx output directory and AutoAPI output:
```bash
cd docs && make clean
```
When writing documentation you can use the convenience command below. This rebuilds
the Sphinx project when source files change and automatically reloads your browser.
Please note that in order for the `make watch` command to work, you will have to
run `make html` first at least once.
```bash
cd docs && make watch
```
## Contributing
The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please
refer to [the style guide](https://docs.dissect.tools/en/latest/contributing/style-guide.html).
## Copyright and license
Dissect is released as open source by Fox-IT () part of NCC Group Plc
().
Developed by the Dissect Team () and made available at .
License terms: AGPL3 (). For more information, see the LICENSE file.