{"id":20198175,"url":"https://github.com/osgeo/osgeolive-doc","last_synced_at":"2025-04-04T06:09:38.007Z","repository":{"id":32069869,"uuid":"35641744","full_name":"OSGeo/OSGeoLive-doc","owner":"OSGeo","description":"Documentation of OSGeoLive project.","archived":false,"fork":false,"pushed_at":"2024-10-29T18:32:27.000Z","size":550184,"stargazers_count":33,"open_issues_count":1,"forks_count":122,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-10-29T18:44:49.329Z","etag":null,"topics":["documentation"],"latest_commit_sha":null,"homepage":"https://live.osgeo.org","language":"Shell","has_issues":false,"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/OSGeo.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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":"2015-05-14T23:10:37.000Z","updated_at":"2024-10-29T17:32:00.000Z","dependencies_parsed_at":"2024-11-06T11:49:13.243Z","dependency_job_id":null,"html_url":"https://github.com/OSGeo/OSGeoLive-doc","commit_stats":{"total_commits":8581,"total_committers":294,"mean_commits":"29.187074829931973","dds":0.8948840461484675,"last_synced_commit":"6fb8f79d981288548cd3f6b2d1ac979dcb4c5cd8"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OSGeo%2FOSGeoLive-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OSGeo%2FOSGeoLive-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OSGeo%2FOSGeoLive-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OSGeo%2FOSGeoLive-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OSGeo","download_url":"https://codeload.github.com/OSGeo/OSGeoLive-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247128753,"owners_count":20888235,"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"],"created_at":"2024-11-14T04:29:37.957Z","updated_at":"2025-04-04T06:09:37.985Z","avatar_url":"https://github.com/OSGeo.png","language":"Shell","readme":"Building OSGeoLive Documentation\n================================\n\nThe following steps describe how to build OSGeoLive_ documentation on an Ubuntu\nbased operating system (such as Lubuntu).\n\nhttps://osgeo.github.io/OSGeoLive-doc/ - automated publication of latest docs from GitHub.\nYou can see the [build script here](.travis.yml).\n\nAbout OSGeoLive\n~~~~~~~~~~~~~~~\n\nOSGeoLive_ is a self-contained bootable DVD, USB thumb drive or Virtual\nMachine based on Lubuntu, that allows you to try a wide variety of open source\ngeospatial software without installing anything. It is composed entirely of\nfree software, allowing it to be freely distributed, duplicated and passed\naround.\n\nreStructured Text\n~~~~~~~~~~~~~~~~~\n\nThe majority of OSGeoLive documentation is generated from reStructured text (reSt) sources\nusing Sphinx. reSt is similar to wiki markup, and readable in plain ASCII. As a\nquick check, GitHub will (partially) render reSt documents as HTML.\n\nBuilding steps\n~~~~~~~~~~~\n\nFollowing the steps below on the OSGeoLive Virtual Machine itself is one of the easiest ways\nto build the OSGeoLive documentation.\n\nFirst install Python and create a virtual environment.\n\n1.0 Requirements\nYou might need to install `git` and `cmake` if they are not on your system yet.\n::\n   # Install git and cmake\n   sudo apt-get install git cmake\n\n\n1.1 For Python 3\n::\n   # Install pip\n   sudo apt-get install python3-pip\n   sudo apt-get install python3-venv\n\n   # Prepare python environment\n   python3 -m venv py-env\n\n   # activate the environment\n   source py-env/bin/activate\n\n   # Python requirements\n   pip install -r requirements.txt\n\n1.2 Requirements for the presentation\n\n::\n   sudo apt-get install cpanminus\n   sudo cpanm Text::SimpleTable::AutoWidth\n\n\n2.1 For Ubuntu 20.04 (Focal Fossa)\nTo build onto Focal Fossa, you will need `specific packages \u003chttps://github.com/OSGeo/OSGeoLive-doc/blob/master/debian/control#L5-L12\u003e`_:\n::\n   # Packages required for doc building on Ubuntu 20.04\n   sudo apt install debhelper python3-sphinx python3-stemmer python3-pil \\\n   pngquant cmake libtext-simpletable-autowidth-perl \\\n\n.. TODO sphinx-revealjs is now used\n   python3-sphinxjp.themes.revealjs\n\n3. Clone or download OSGeoLive source documentation\n::\n   git clone https://github.com/OSGeo/OSGeoLive-doc.git\n\n4. Generate the English documentation\n::\n   cd OSGeoLive-doc\n   mkdir build\n   cd build\n   cmake -DHTML=ON ..\n   make\n   cd ..\n\nThe output is in `build/doc/_build/html/`\n\n5. Generate another language documentation\n::\n   cd build\n   cmake -DHTML=ON -DFR=ON ..\n   make\n   cd ..\n\nAdding -DFR=ON adds the French language, adding another -DES=ON adds Spanish, and so on.\nThe output is also in `build/doc/_build/html/`\n\n6. To build all available languages\n::\n   cd build\n   cmake -DHTML=ON -DALL_LANG=ON ..\n   make\n   cd ..\n\n7. *Optional*: reduce the size of the generated documentation\n::\n   bash scripts/clean-images.sh\n\nContributing:\n~~~~~~~~~~~~~\n\nInformation about how to document the projects on OSGeoLive can be found on the OSGeoLive wiki: https://trac.osgeo.org/osgeolive/wiki\n\n* `How to document a project \u003chttps://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20a%20project\u003e`__\n* `How to configure project documentation \u003chttps://trac.osgeo.org/osgeolive/wiki/How%20to%20configure%20a%20project%20documentation\u003e`__\n* `How to document the overview file \u003chttps://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20overview%20file\u003e`__\n* `How to document the quickstart file \u003chttps://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file\u003e`__\n* `Weblate translation platform \u003chttps://osgeo.github.io/OSGeoLive-doc/en/index.html\u003e`__\n\n\nReferences:\n~~~~~~~~~~~\n\n* https://wiki.osgeo.org/wiki/Live_GIS_Add_Project#Application_Overview\n\n* https://www.sphinx-doc.org\n\n* http://docutils.sf.net/rst.html\n\n* http://matplotlib.sourceforge.net/sampledoc/\n\n* https://osgeo.github.io/OSGeoLive-doc/ - automated publication of latest docs from GitHub\n\n.. _OSGeoLive: https://live.osgeo.org\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosgeo%2Fosgeolive-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosgeo%2Fosgeolive-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosgeo%2Fosgeolive-doc/lists"}