{"id":20207741,"url":"https://github.com/exasol/sphinx-github-pages-generator","last_synced_at":"2025-05-07T07:32:18.902Z","repository":{"id":37409276,"uuid":"434254525","full_name":"exasol/sphinx-github-pages-generator","owner":"exasol","description":"Automatic generation of sphinx GitHub pages for a given repository.","archived":true,"fork":false,"pushed_at":"2024-12-16T12:56:37.000Z","size":665,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-03T10:14:51.401Z","etag":null,"topics":["documentation","exasol-integration","integration","python"],"latest_commit_sha":null,"homepage":"https://exasol.github.io/sphinx-github-pages-generator/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/exasol.png","metadata":{"files":{"readme":"README.rst","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}},"created_at":"2021-12-02T14:33:08.000Z","updated_at":"2024-12-16T12:58:12.000Z","dependencies_parsed_at":"2024-11-14T05:31:53.721Z","dependency_job_id":null,"html_url":"https://github.com/exasol/sphinx-github-pages-generator","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exasol%2Fsphinx-github-pages-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exasol%2Fsphinx-github-pages-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exasol%2Fsphinx-github-pages-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exasol%2Fsphinx-github-pages-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/exasol","download_url":"https://codeload.github.com/exasol/sphinx-github-pages-generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252833764,"owners_count":21811251,"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","exasol-integration","integration","python"],"created_at":"2024-11-14T05:31:46.710Z","updated_at":"2025-05-07T07:32:18.893Z","avatar_url":"https://github.com/exasol.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Sphinx GitHub Pages Generator\n*****************************\n\n.. _docu_start:\n\n**This Repository is archived and not in active development anymore, please use the** `Exasol Python Toolbox \u003chttps://github.com/exasol/python-toolbox\u003e`_ **instead.**\n\nOverview\n========\n\nThis project provides a python library for accessing automatic generation of sphinx GitHub pages \nfor a given repository. It is intended for the use with a Continuous Integration solution.\nDeveloped using GitHub Actions.\nWe are using Sphinx for generating the documentation,\nbecause it is the default documentation tool for Python projects.\nSphinx supports reStructuredText with appropriate cross-document references.\nWe use the MyST-Parser to also integrate markdown files into the documentation.\n\nIn a Nutshell\n=============\n\nMotivation\n----------\n\nUsing Sphinx for building the documentation of a project in the CI is a bit different to the steps you can use during coding,\nbecause it also contains the preparations for publishing. At the moment, we publish\nthe documentation on Github Pages.\n\nTo publish it there, the HTML needs to be built from the documentation source and committed. It also needs to be ensured\nit adheres to the file structure expected by GitHub Pages.\nOur usual directory structure doesn't fit these requirements, so we decided to create\na new Git root commit and initially set github-pages/main branch to this commit.\nWe then add new commits to this branch to update existing or add new versions of the documentation.\n\nThis has the additional benefit, that we don't have automatic commits to the source branch.\nFor each branch or tag for which we build the documentation in the CI\nwe add a directory to the root directory of the github-pages/main branch.\n\nFor simplification of this process, we build the Sphinx_GitHub-Pages-Generator.\n\nPrerequisites\n-------------\n\n- Python 3.8+\n\nInstallation\n-------------\n..\n    _This: todo fix installation description\n\nInstall the package from Github via `pip`::\n\n    pip install -e git://github.com/exasol/sphinx-github-pages-generator.git@{tag name}#egg=exasol-sphinx-github-pages-generator\n\nDocumentation\n-------------\n\n`Documentation for the latest release \u003chttps://exasol.github.io/sphinx-github-pages-generator/main/\u003e`_ is hosted on the Github Pages of this project.\n\nFeatures\n========\n\n* Build html documentation files using Sphinx\n* Choose which remote branch to generate the documentation from\n* Choose whether to automatically push the generated and committed documentation or not.\n* Works with multiple packages in one repository.\n* Generates a index.html file containing links to all existing documentations on that branch.\n  This file is generated using the \"furo\" theme.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexasol%2Fsphinx-github-pages-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexasol%2Fsphinx-github-pages-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexasol%2Fsphinx-github-pages-generator/lists"}