{"id":20172006,"url":"https://github.com/elabftw/elabdoc","last_synced_at":"2025-06-26T07:03:07.428Z","repository":{"id":39618043,"uuid":"71017819","full_name":"elabftw/elabdoc","owner":"elabftw","description":"Source files for generating documentation for elabftw","archived":false,"fork":false,"pushed_at":"2025-06-17T13:38:21.000Z","size":9636,"stargazers_count":12,"open_issues_count":0,"forks_count":22,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-06-17T13:39:32.723Z","etag":null,"topics":["documentation-code","hacktoberfest","restructuredtext"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elabftw.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":"FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"liberapay":"NicolasCARPi","github":"NicolasCARPi"}},"created_at":"2016-10-15T22:49:33.000Z","updated_at":"2025-06-17T13:38:25.000Z","dependencies_parsed_at":"2023-10-14T23:15:10.023Z","dependency_job_id":"afe0a382-38e6-44b5-ac16-1d3351c2b9f0","html_url":"https://github.com/elabftw/elabdoc","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/elabftw/elabdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elabftw%2Felabdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elabftw%2Felabdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elabftw%2Felabdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elabftw%2Felabdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elabftw","download_url":"https://codeload.github.com/elabftw/elabdoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elabftw%2Felabdoc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262018677,"owners_count":23245618,"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":["documentation-code","hacktoberfest","restructuredtext"],"created_at":"2024-11-14T01:28:42.096Z","updated_at":"2025-06-26T07:03:07.403Z","avatar_url":"https://github.com/elabftw.png","language":null,"funding_links":["https://liberapay.com/NicolasCARPi","https://github.com/sponsors/NicolasCARPi"],"categories":[],"sub_categories":[],"readme":"# elabdoc\n\n## Description\n\nSource files for the [elabftw documentation](https://doc.elabftw.net).\n\nMain project repository: [elabftw/elabftw](https://github.com/elabftw/elabftw).\n\n## Installation\n\n~~~bash\ngit clone https://github.com/elabftw/elabdoc\ncd elabdoc\npython -m venv venv\nsource venv/bin/activate\npip install -r requirements.txt\n~~~\n\n## Config examples\n\nYou might want to look into the [config_examples](./config_examples) folder for Apache, HAProxy, Nginx or Traefik configuration as reverse proxy.\n\n## Usage\n\nTo generate the HTML documentation:\n\n~~~bash\ncd doc\nmake html\n~~~\n\nThen point your browser to the `_build/html/index.html` file inside the `doc/` folder.\n\n## CI\n\nThe generated documentation can also be accessed in the Artifacts section of the [CircleCI builds](https://app.circleci.com/pipelines/github/elabftw/elabdoc).\n\nClick on \"pdf\" to get the doc as a pdf.\n\n## Headings used\n\n~~~rst\n***********\nMAIN HEADER\n***********\n\nTITLE\n=====\n\nSUBTITLE\n--------\n\nSUBSUBTITLE\n^^^^^^^^^^^\n\nSUBSUBSUBTITLE\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n~~~\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felabftw%2Felabdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felabftw%2Felabdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felabftw%2Felabdoc/lists"}