{"id":38572565,"url":"https://github.com/sphinx-notes/pages","last_synced_at":"2026-01-17T08:03:24.873Z","repository":{"id":37042649,"uuid":"318463978","full_name":"sphinx-notes/pages","owner":"sphinx-notes","description":"Github Actions for publishing Sphinx HTML output to github pages","archived":false,"fork":false,"pushed_at":"2025-10-16T16:38:57.000Z","size":75,"stargazers_count":94,"open_issues_count":7,"forks_count":34,"subscribers_count":1,"default_branch":"v3","last_synced_at":"2025-12-19T20:21:51.340Z","etag":null,"topics":["github-actions","github-pages","sphinx","sphinx-documentation"],"latest_commit_sha":null,"homepage":"https://sphinx.silverrainz.me/pages/","language":"Shell","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/sphinx-notes.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,"zenodo":null}},"created_at":"2020-12-04T09:18:06.000Z","updated_at":"2025-12-09T22:39:26.000Z","dependencies_parsed_at":"2023-01-04T18:32:17.691Z","dependency_job_id":"ee0c2966-7d33-43df-8441-87069983b4f1","html_url":"https://github.com/sphinx-notes/pages","commit_stats":{"total_commits":71,"total_committers":7,"mean_commits":"10.142857142857142","dds":0.08450704225352113,"last_synced_commit":"3a7b173ecba074b270b37c64007c1edfd8465892"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/sphinx-notes/pages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-notes%2Fpages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-notes%2Fpages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-notes%2Fpages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-notes%2Fpages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-notes","download_url":"https://codeload.github.com/sphinx-notes/pages/tar.gz/refs/heads/v3","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-notes%2Fpages/sbom","scorecard":{"id":841326,"data":{"date":"2025-08-11","repo":{"name":"github.com/sphinx-notes/pages","commit":"16601c3551fb1aff4d3f9cbffe7f8c86e123c917"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.9,"checks":[{"name":"Code-Review","score":1,"reason":"Found 3/22 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":6,"reason":"3 commit(s) and 5 issue activity found in the last 90 days -- score normalized to 6","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":9,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/pages.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/pages.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/sphinx-notes/pages/pages.yml/v3?enable=pin","Warn: pipCommand not pinned by hash: main.sh:26","Warn: pipCommand not pinned by hash: main.sh:28","Warn: pipCommand not pinned by hash: main.sh:45","Warn: pipCommand not pinned by hash: main.sh:55","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   4 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'v3'","Warn: branch protection not enabled for branch 'v2'","Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 21 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T20:33:05.526Z","repository_id":37042649,"created_at":"2025-08-23T20:33:05.526Z","updated_at":"2025-08-23T20:33:05.526Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28504358,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T06:57:29.758Z","status":"ssl_error","status_checked_at":"2026-01-17T06:56:03.931Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["github-actions","github-pages","sphinx","sphinx-documentation"],"created_at":"2026-01-17T08:03:24.698Z","updated_at":"2026-01-17T08:03:24.853Z","avatar_url":"https://github.com/sphinx-notes.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"=========================\nSphinx to GitHub Pages V3\n=========================\n\n.. image:: https://img.shields.io/github/stars/sphinx-notes/pages.svg?style=social\u0026label=Star\u0026maxAge=2592000\n   :target: https://github.com/sphinx-notes/pages\n\nHelps you deploy your Sphinx documentation to Github Pages.\n\nUsage\n=====\n\nWe provides two ways for publishing GitHub pages.\nThe first one is the default but **still in beta**, use the second one if you tend to be stable.\n\nPublishing with this action (default)\n***************************************\n\n1. `Set the publishing sources to \"Github Actions\"`__\n2. Create the following workflow:\n\n   .. code-block:: yaml\n\n      name: Deploy Sphinx documentation to Pages\n\n      on:\n        push:\n          branches: [master] # branch to trigger deployment\n\n      jobs:\n        pages:\n          runs-on: ubuntu-latest\n          environment:\n            name: github-pages\n            url: ${{ steps.deployment.outputs.page_url }}\n          permissions:\n            pages: write\n            id-token: write\n          steps:\n          - id: deployment\n            uses: sphinx-notes/pages@v3\n\n__ https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow\n\nPublishing from a branch (classical)\n************************************\n\n1. Create a branch ``gh-pages``\n2. `Set the publishing sources to \"Deploy from a branch\"`__, then specify the branch just created\n3. Create the following workflow, in this way user need to publish the site by another action,\n   we use `peaceiris/actions-gh-pages`__ here:\n\n   .. code-block:: yaml\n\n      name: Deploy Sphinx documentation to Pages\n\n      on:\n        push:\n          branches: [master] # branch to trigger deployment\n\n      jobs:\n        pages:\n          runs-on: ubuntu-latest\n          steps:\n          - id: deployment\n            uses: sphinx-notes/pages@v3\n            with:\n              publish: false\n          - uses: peaceiris/actions-gh-pages@v3\n            with:\n              github_token: ${{ secrets.GITHUB_TOKEN }}\n              publish_dir: ${{ steps.deployment.outputs.artifact }}\n\n__ https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch\n__ https://github.com/peaceiris/actions-gh-pages\n\nInputs\n======\n\n========================== ============================ ======== =================================================\nInput                      Default                      Required Description\n-------------------------- ---------------------------- -------- -------------------------------------------------\n``documentation_path``     ``./docs``                   false    Path to Sphinx source files\n``requirements_path``      ``./docs/requirements.txt``  false    Path to to requirements file,\n                                                                 used in ``pip install -r XXX`` command\n``pyproject_extras``       ``docs``                     false    Extras of `Requirement Specifier`__\n                                                                 used in ``pip install .[XXX]``\n========================== ============================ ======== =================================================\n\nAdvanced\n********\n\nIn most cases you don't need to know about the following inputs.\nUnless you need to highly customize the action's behavior.\n\n========================== ============================ ======== =================================================\nInput                      Default                      Required Description\n-------------------------- ---------------------------- -------- -------------------------------------------------\n``python_version``         ``3.12``                     false    Version of Python\n``sphinx_version``         ``latest``                   false    Version of Sphinx\n``sphinx_build_options``                                false    Additional options passed to ``sphinx-build``\n``cache``                  ``false``                    false    Enable cache to speed up documentation building\n``checkout``               ``true``                     false    Whether to automatically checkout the repository,\n                                                                 if false, user need to do it byself\n``publish``                ``true``                     false    Whether to automatically publish the repository\n========================== ============================ ======== =================================================\n\n__ https://pip.pypa.io/en/stable/reference/requirement-specifiers/#overview\n\nOutputs\n=======\n\n======================= =========================================================\nOutput                  Description\n----------------------- ---------------------------------------------------------\n``page_url``            URL to deployed GitHub Pages,\n                        only available when option ``publish`` is set to ``true``\n``artifact``            Directory where artifact (HTML documentation) is stored,\n                        user can use it to deploy GitHub Pages manually\n======================= =========================================================\n\nExamples\n========\n\nThe following repository's pages are built by this action:\n\n- https://github.com/SilverRainZ/bullet\n- https://github.com/sphinx-notes/pages\n- https://github.com/sphinx-notes/lilypond\n- https://github.com/sphinx-notes/strike\n- `and more...`__\n\nYou can find the workflow file in the above repositories.\n\n__ https://github.com/sphinx-notes/pages/network/dependents\n\nTips\n====\n\nCopy extra files to site\n************************\n\nUse Sphinx confval html_extra_path__.\n\n__ https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path\n\nCancel any in-progress job\n**************************\n\nIt is useful when you have pushed a new commit to remote but the job of the previous \ncommit is not finished yet. See concurrency__ for more details.\n\n.. code-block:: yaml\n\n   concurrency:\n     group: ${{ github.ref }}\n     cancel-in-progress: true\n\n__ https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency\n\nInstall extra dependencies\n**************************\n\nFor python dependencies, just add them to your ``requirements.txt`` or ``pyproject.toml`` file.\n\nFor non-python dependencies, add a step to your workflow file, and install them with the appropriate tools\n(such as apt, wget, ...). See `#24`__ for example.\n\n__ https://github.com/sphinx-notes/pages/issues/24\n\nCustomize checkout options\n**************************\n\nRepository is automatically checkout by default, but some user may need to customize checkout options\n(For example, checkout private repository, checkout multiple repositories).\nFor this case, user can set the ``checkout`` options to ``false``, then use `action/checkout`__ byeself.\n\n.. code:: yaml\n\n   steps:\n   - uses: actions/checkout@master\n     with:\n       YOUR_CUSTOM_OPTIONS: ...\n   - id: deployment\n     uses: sphinx-notes/pages@v3\n     with:\n       checkout: false\n\n__ https://github.com/actions/checkout\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-notes%2Fpages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-notes%2Fpages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-notes%2Fpages/lists"}