{"id":26628185,"url":"https://github.com/peterhys/sphinx-docs-action","last_synced_at":"2025-04-10T13:50:49.597Z","repository":{"id":65161279,"uuid":"543294148","full_name":"peterhys/sphinx-docs-action","owner":"peterhys","description":"Build and generate sphinx documentation based on poetry or setuptools pyproject.toml dependencies.","archived":false,"fork":false,"pushed_at":"2025-02-28T04:17:11.000Z","size":21,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T20:59:18.262Z","etag":null,"topics":["action","deployment","poetry","sphinx"],"latest_commit_sha":null,"homepage":"","language":null,"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/peterhys.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"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":"2022-09-29T19:48:28.000Z","updated_at":"2025-02-28T04:17:15.000Z","dependencies_parsed_at":"2025-03-08T05:36:54.945Z","dependency_job_id":null,"html_url":"https://github.com/peterhys/sphinx-docs-action","commit_stats":{"total_commits":11,"total_committers":2,"mean_commits":5.5,"dds":0.09090909090909094,"last_synced_commit":"5f5bbe1edcd503d75e15d062d8561272071e3221"},"previous_names":["peterhys/sphinx-docs-action","peterhs73/sphinx-docs-action"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterhys%2Fsphinx-docs-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterhys%2Fsphinx-docs-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterhys%2Fsphinx-docs-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterhys%2Fsphinx-docs-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peterhys","download_url":"https://codeload.github.com/peterhys/sphinx-docs-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248228269,"owners_count":21068653,"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":["action","deployment","poetry","sphinx"],"created_at":"2025-03-24T12:28:23.814Z","updated_at":"2025-04-10T13:50:49.577Z","avatar_url":"https://github.com/peterhys.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# sphinx-docs\nBuild and deploy sphinx documentation based on pyproject.toml parameters.\n\nThe action is a composite action, and install the package with extras in the environment.\nTo specify the extras, define the pyproject-path input. For example, if the dependencies\nof documentation are under the \"docs\" extra, the pyproject-path should be \".[docs]\".\n\nAn example of using this action, triggered when a release is published:\n\n```yaml\nname: Build and publish to github repo\n\non:\n  release:\n    types: [published]\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Deploy\n        uses: peterhs73/sphinx-docs-action@v0.1.0\n        with:\n          python-version: 3.8\n          docs-source: docs/\n          pyproject-path: .[docs]\n          external-repo: peterhs73/sphinx-docs\n          deploy-token: ${{secrets.PRIVATE_TOKEN}}\n\n```\n\nTo push documentation to the external GitHub page, an ssh key pair needs to be created.\nOnce ssh key is generated \n([how to generate new ssh key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)),\nstore the public key in the external repository (settings \u003e security \u003e deploy keys \u003e \nadd deploy key). Store the private key in the current repository\n(settings \u003e security \u003e secrets \u003e actions \u003e new repository secret) and the secret name\nshould be \"PRIVATE_TOKEN\".\n\n\n## Version 0.1.1 (2023-03-31)\n\nVersion 0.1.1 parses and installs the dependencies from pyproject.toml file\nwithout install the package.\nThe user needs to input the dependency location, i.e. \"tool.poetry.dependencies\".\nThe parser installs all dependencies including the optional ones.\n\nFor poetry style dependencies, the versioning is converted to the pip style. For details on poetry dependencies, please refer to [poetry documentation](https://python-poetry.org/docs/dependency-specification/).\n\n\u003e **Warning**\n\u003e Multiple constraints, git dependencies, and path dependencies are not supported. For these\n\u003e dependencies, the user should add a separate requirement section in the pyproject.toml file.\n\nFor setuptools dependencies, the user needs to input the dependency list location, to access the dependencies under \"[project]\" section, the \"dependency-path\" should be \"project.dependencies\".\n\nPlease see the action.yaml input section for all the input information.\n\nAn example of using this action, triggered when a release is published:\n\n```yaml\nname: Build and publish to github repo\n\non:\n  release:\n    types: [published]\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Deploy\n        uses: peterhs73/sphinx-docs-action@v0.1.0\n        with:\n          python-version: 3.8\n          docs-source: docs/\n          dependency-path: tool.poetry.dependencies\n          external-repo: peterhs73/sphinx-docs\n          deploy-token: ${{secrets.PRIVATE_TOKEN}}\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterhys%2Fsphinx-docs-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeterhys%2Fsphinx-docs-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterhys%2Fsphinx-docs-action/lists"}