{"repo":"uibcdf/action-sphinx-docs-to-gh-pages","free":true,"listed":false,"github":"https://github.com/uibcdf/action-sphinx-docs-to-gh-pages","clone":"git clone https://github.com/uibcdf/action-sphinx-docs-to-gh-pages.git","description":"GitHub Action: The sphinx documentation in a repository is compiled and deployed to GitHub Pages through the gh-pages branch.","language":null,"stars":17,"topics":["github-actions","actions"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"action-sphinx-docs-to-gh-pages The Sphinx documentation in a repository is automatically compiled as 'html' and deployed, by means of the gh-pages branch, with this GitHub Actions to GitHub Pages. The user has only to be sure that the repository accomplishes a couple of requirements. In summary, this GitHub action does the following: - Takes the author and SHA id of the trigger action ( push or pull request ) to be consistent along the action. - Creates a new gh-pages branch if this is not already in the repository. - Compiles the sphinx documentation in the directory and branch specified by the user. - Pushes the output html documentation to the gh-pages branch. What changed in v3.0.0 sphinx-apidoc no longer runs by default. It used to, and it generates one .rst file per package and subpackage into dir docs . A project that maintains its own API reference — written by hand, or generated with autosummary from pages it controls — was getting a second, parallel API tree that no toctree includes, built and published all the same, with one Sphinx warning per file. That is the wrong default for such a project, and it was silent. If your API reference is the one sphinx-apidoc produces, set sphinx-apidoc: true and nothing else changes. When the step is skipped the action now says so in the workflow log, because a missing page sends you to the log and not to this README. A failed compilation used to be reported as a success. The sphinx-apidoc and sphinx-build steps ran under a login ","default_branch":null,"files":null,"tree":[],"storefront":"/r/uibcdf","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/uibcdf/action-sphinx-docs-to-gh-pages/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}