{"id":28918751,"url":"https://github.com/libresign/documentation","last_synced_at":"2026-03-16T15:37:24.740Z","repository":{"id":291162206,"uuid":"976783844","full_name":"LibreSign/documentation","owner":"LibreSign","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-13T13:12:10.000Z","size":13750,"stargazers_count":2,"open_issues_count":15,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-14T00:11:57.167Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.libresign.coop","language":"Python","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/LibreSign.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"libresign"}},"created_at":"2025-05-02T18:37:57.000Z","updated_at":"2025-06-13T16:07:51.000Z","dependencies_parsed_at":"2025-05-27T15:36:26.499Z","dependency_job_id":"e1e2c4a4-933d-4e6c-baee-18a6ec6a621b","html_url":"https://github.com/LibreSign/documentation","commit_stats":null,"previous_names":["libresign/documentation"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/LibreSign/documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LibreSign%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LibreSign%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LibreSign%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LibreSign%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LibreSign","download_url":"https://codeload.github.com/LibreSign/documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LibreSign%2Fdocumentation/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261226311,"owners_count":23127298,"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-22T02:38:53.621Z","updated_at":"2026-03-16T15:37:24.690Z","avatar_url":"https://github.com/LibreSign.png","language":"Python","readme":"=======================\nLibreSign Documentation\n=======================\n\nDocumentation is published on `\u003chttps://docs.libresign.coop\u003e`_.\nTo edit it yourself, you need to tinker a bit with Git and Sphinx.\nSee the `Style Guide \u003chttps://github.com/nextcloud/documentation/blob/master/style_guide.rst\u003e`_ for formatting and style conventions.\n\nManuals\n-------\n\nThis repository hosts three manuals:\n\n* **Users' Manual**\n* **Administration Manual**\n* **Developers Manual**\n\nPlease wrap lines at 80 characters.\n\nSpelling and Capitalization Conventions\n---------------------------------------\n\n* Nextcloud\n* LibreSign\n\nLicense\n-------\n\nAll documentation in this repository is licensed under the Creative Commons\nAttribution 3.0 Unported license (`CC BY 3.0`_).\n\n.. _CC BY 3.0: https://creativecommons.org/licenses/by/3.0/deed.en_US\n\nStyle\n-----\n\nSource files are written using the `Sphinx Documentation Generator\n\u003chttps://www.sphinx-doc.org/en/master/\u003e`_. The syntax follows the `reStructuredText\n\u003chttp://docutils.sourceforge.net/rst.html\u003e`_ style, and can also be edited\nfrom GitHub.\n\nStructure\n---------\n\nOf course, think about structure. Keep in mind that we try NOT to move or rename\npages once they are created! Lots of external sources link to our documentation,\nincluding the indexing by search engines of course. So once you create a page with a certain\nname, it has to stay in that location and with that name. Think of it as API stability\n- we have to ensure things stay as they are as much as possible. Renaming or moving\nis only allowed in exceptional circumstances and only when a redirect is put in place.\n\nEditing\n-------\n\nContributing to the documentation requires a GitHub account.\n\nTo edit a document, you can edit the .rst files on your local system, or work\ndirectly on GitHub. The latter is only suitable for small fixes and improvements\nbecause substantial editing efforts can better be controlled on your local PC.\n\nThe best way is to install a complete Sphinx build environment and work on your\nlocal PC or using the docker-compose that stay at home folder of this repository.\nYou will be able to make your own local builds, which is the fastest\nand best way to preview for errors. Sphinx will report syntax errors, missing\nimages, and formatting errors. The GitHub preview is not complete and misses\nmany mistakes. Create a new branch against the main, make your edits, then push\nyour new branch to GitHub and open a new PR.\n\nTo edit on GitHub, fork the repository (see top-right of the screen, under\nyour username). You will then be able to make changes easily. Once done,\nyou can create a pull request and get the changes reviewed and back into\nthe official repository.\n\nWhen editing either on your own local PC or on GitHub, be sure to sign of\ncommits, to certify adherence to the Developer Certificate of Origin,\nsee https://github.com/probot/dco . Your commit messages need to have,\nthe name and email address of the contributor.\n\n  Signed-off-by: Awesome Contributor \u003cawesome.contributor@reach.me\u003e\n\nIf using the command line and your name and email are configured, you can use\n\n  git commit -s -m 'Commit message'\n\nIn both settings be sure that your email address matches that in your GitHub profile,\nwhich if you have privacy enabled will be github.username@users.noreply.github.com\n\n\nBuilding\n--------\n\nBuilding HTML\n=============\n\nUsing pipenv\n^^^^^^^^^^^^\n\n1. Install ``pipenv`` - https://pipenv.readthedocs.io/en/latest/\n2. Change into the environment: ``pipenv shell``\n3. Install the dependencies ``pip install -r docs/requirements.txt``\n4. Now you can use ``make ...`` to build all the stuff - for example ``make html`` to build the HTML flavor of all manuals\n   The build assets will be put into the individual documentation subdirectories like ``developer_manual/_build/html/com``\n\nTo change into this environment you need to run ``pipenv shell`` to launch the shell and to exit you can use either ``exit`` or ``Ctrl`` + ``D``.\n\nUsing venv\n^^^^^^^^^^\n\n1. Install ``python3-venv``\n2. Only once: Create a venv (typically inside this repository): ``python -m venv venv``\n3. Activate the environment (inside this repository): ``source venv/bin/activate``\n4. Install the dependencies ``pip install -r docs/requirements.txt``\n5. Now you can use ``make ...`` to build all the stuff - for example ``make html`` to build the HTML flavor of all manuals\n   The build assets will be put into the individual documentation subdirectories like ``developer_manual/_build/html/com``\n\nAutobuilding\n^^^^^^^^^^^^\n\nWhen editing the documentation installing ``sphinx-autobuild`` though pip can be helpful. This will watch file changes and automatically reload the html preview:\n\n1. Install ``pip install sphinx-autobuild``\n2. Enter the documentation section ``cd user_manual``\n3. Watch for file changes ``make SPHINXBUILD=sphinx-autobuild html``\n4. Open http://127.0.0.1:8000 in the browser and start editing\n\nUsing the VSCode DevContainer\n=============================\n\nThis repository contains a full-featured `VSCode DevContainer \u003chttps://code.visualstudio.com/docs/devcontainers/containers\u003e`_.\nYou can use it in your local development environment or via `GitHub Codespaces \u003chttps://github.com/features/codespaces\u003e`_.\nJust open the container an use one of the commands from above to build the project. For example ``make`` to build the full\ndocumentation. You can also use ``make SPHINXBUILD=sphinx-autobuild html``\nin combination with `port forwarding \u003chttps://code.visualstudio.com/docs/devcontainers/containers#_forwarding-or-publishing-a-port\u003e`_\nto  watch file changes and automatically reload the html preview.\n\nUsign docker\n============\nYou can also use the `docker-compose.yml` file to build the documentation using\nDocker. This is useful if you want to avoid installing Python and its\ndependencies on your local machine.\n\n1. Make sure you have Docker and Docker Compose installed.\n2. Open a terminal and navigate to the root directory of the repository.\n3. Run the following command to build the documentation:\n\n   ``docker-compose up``\n\n   This will build the HTML documentation and place it in the `volumes/html` directory.\n   And also will start a HTTP server and you can access the documentation at `http://localhost:8000`.\n\n4. To stop the server, press `Ctrl+C` in the terminal.\n\n\n.. _CC BY 3.0: https://creativecommons.org/licenses/by/3.0/deed.en_US\n.. _`Xcode command line tools`: https://stackoverflow.com/questions/9329243/xcode-install-command-line-tools\n\nThis README was based on the `Nextcloud documentation \u003chttps://github.com/nextcloud/documentation/blob/master/README.rst\u003e`_.","funding_links":["https://github.com/sponsors/libresign"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibresign%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibresign%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibresign%2Fdocumentation/lists"}