{"id":28486132,"url":"https://github.com/fox-it/dissect-docs","last_synced_at":"2025-07-02T12:32:35.991Z","repository":{"id":64058397,"uuid":"513435057","full_name":"fox-it/dissect-docs","owner":"fox-it","description":"Dissect documentation project","archived":false,"fork":false,"pushed_at":"2025-06-27T11:06:20.000Z","size":328,"stargazers_count":8,"open_issues_count":6,"forks_count":7,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-06-27T12:24:36.596Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fox-it.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-07-13T08:11:04.000Z","updated_at":"2025-05-20T13:14:30.000Z","dependencies_parsed_at":"2023-02-15T19:15:36.488Z","dependency_job_id":"fe6a308c-e0fc-4eb8-8efb-3b291a7c358b","html_url":"https://github.com/fox-it/dissect-docs","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/fox-it/dissect-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fox-it%2Fdissect-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fox-it%2Fdissect-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fox-it%2Fdissect-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fox-it%2Fdissect-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fox-it","download_url":"https://codeload.github.com/fox-it/dissect-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fox-it%2Fdissect-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263140570,"owners_count":23419906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-08T01:10:21.221Z","updated_at":"2025-07-02T12:32:35.976Z","avatar_url":"https://github.com/fox-it.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dissect documentation\n\nThis project houses the Sphinx documentation for the Dissect project.\n\n## Build and instructions\n\nStart by checking out the submodules if you haven't done so already:\n\n```bash\ngit submodule update --init --recursive\n```\n\nIf you want to update all submodules add `--remote` to the previous command.\n\nCreate a new virtual environment, install the dependencies and build the Sphinx project.\n\n```bash\npip install -r requirements.txt\ncd docs \u0026\u0026 make html\n```\n\nIf you run into build issues, clean the Sphinx output directory and AutoAPI output:\n\n```bash\ncd docs \u0026\u0026 make clean\n```\n\nWhen writing documentation you can use the convenience command below. This rebuilds \nthe Sphinx project when source files change and automatically reloads your browser.\n\nPlease note that in order for the `make watch` command to work, you will have to \nrun `make html` first at least once.\n\n```bash\ncd docs \u0026\u0026 make watch\n```\n\n## Contributing\n\nThe Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please\nrefer to [the style guide](https://docs.dissect.tools/en/latest/contributing/style-guide.html).\n\n## Copyright and license\n\nDissect is released as open source by Fox-IT (\u003chttps://www.fox-it.com\u003e) part of NCC Group Plc\n(\u003chttps://www.nccgroup.com\u003e).\n\nDeveloped by the Dissect Team (\u003cdissect@fox-it.com\u003e) and made available at \u003chttps://github.com/fox-it/dissect\u003e.\n\nLicense terms: AGPL3 (\u003chttps://www.gnu.org/licenses/agpl-3.0.html\u003e). For more information, see the LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffox-it%2Fdissect-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffox-it%2Fdissect-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffox-it%2Fdissect-docs/lists"}