{"id":26150378,"url":"https://github.com/3liz/lizmap-documentation","last_synced_at":"2025-04-14T04:20:59.804Z","repository":{"id":7307340,"uuid":"8624734","full_name":"3liz/lizmap-documentation","owner":"3liz","description":"Full documentation for Lizmap Web Client and Lizmap Plugin","archived":false,"fork":false,"pushed_at":"2025-04-09T08:13:48.000Z","size":96351,"stargazers_count":20,"open_issues_count":31,"forks_count":40,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-09T08:37:15.312Z","etag":null,"topics":["documentation","lizmap"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3liz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"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}},"created_at":"2013-03-07T10:11:55.000Z","updated_at":"2025-04-09T08:13:24.000Z","dependencies_parsed_at":"2023-10-15T03:59:40.659Z","dependency_job_id":"bc4c5229-d430-4d23-8007-dd9eac2b6d72","html_url":"https://github.com/3liz/lizmap-documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3liz%2Flizmap-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3liz%2Flizmap-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3liz%2Flizmap-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3liz%2Flizmap-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3liz","download_url":"https://codeload.github.com/3liz/lizmap-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248819645,"owners_count":21166513,"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","lizmap"],"created_at":"2025-03-11T05:59:18.847Z","updated_at":"2025-04-14T04:20:59.781Z","avatar_url":"https://github.com/3liz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation Lizmap 📚\n\nThis repository contains the complete documentation of the Lizmap application.\n\nLizmap allows publishing online QGIS maps.\n\nThe documentation is localized into several languages. The main language is\nthe English.\n\n## Contributing to the English documentation\n\nClone the repository and edit files into `source/`.\n\nThe format is the ReStructured Text format.\n\nRead [CONTRIBUTING.md](./CONTRIBUTING.md) about the structure.\n\nSee below to build the documentation into HTML to see the result.\n\n## Contributing by translating into other languages\n\nWe are using [Transifex](https://www.transifex.com/3liz-1/lizmap-documentation/)\nto translate the documentation. So if you want to contribute to the translation,\ncreate an account on the Transifex website, and translate different strings.\n\nWe retrieve regularly translation and store them into the `i18n/` directory. \n\nWe don't recommend contributing to translations by doing a Pull Request on\nGitHub, as it may be difficult to merge content coming from Transifex and your\nchanges.\n\n## Building the documentation\n\nWe are using the tool [Sphinx](https://sphinx-doc.org) and its\ninternationalization mechanism [sphinx-intl](https://sphinx-doc.org/intl.html) to\ngenerate the HTML content in all languages.\n\nSo install these tools. On Linux / macOS, install Python3, Pip and then:\n\n```bash\npython3 -m venv .venv\n.venv/bin/pip install -r requirements.txt\n```\n\nThen run `make gettext \u0026\u0026 make html`. It will build the docs in all available \nlanguages. To run only in English, you can use `make htmlen`.\n\nTo see all warnings from Sphinx, your build directory must be empty. It will trigger the full build.\nYou can use `rm -rf build/ \u0026\u0026 make htmlen`.\n\n## For core contributor\n\nSee DEV.md to see instructions to push and pull translated files to/from Transifex.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3liz%2Flizmap-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3liz%2Flizmap-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3liz%2Flizmap-documentation/lists"}