{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"}],"enrichment":{"capability":"Automates publishing built documentation to GitHub Pages by managing the gh-pages branch, handling file synchronization, and optionally pushing changes to a remote repository.","skillfed_tags":["github-pages","documentation-deployment","ci-cd"],"use_cases":["Publish Sphinx documentation output to GitHub Pages as part of a build workflow.","Deploy static site generator output to GitHub Pages without manual branch management.","Set up custom domain hosting on GitHub Pages by writing CNAME records during deployment.","Maintain a clean gh-pages history by using the no-history flag to avoid repository bloat.","Deploy documentation to organization or user pages by specifying a different branch instead of gh-pages."],"what_it_does":"ghp-import takes a local documentation directory and commits it to the gh-pages branch with a single command or function call, solving the problem of managing a separate branch for GitHub Pages hosting. It wraps Git operations and provides both a CLI interface and a Python API, optionally pushing the branch to a remote repository, writing CNAME records, and adding .nojekyll files to disable Jekyll processing.\n\nThe package depends only on python-dateutil and runs as a pure-Python wheel, making installation straightforward. It treats the gh-pages branch as fully derivative\u2014it will overwrite the branch's contents on each run unless a prefix is specified\u2014so it assumes documentation is regenerated and re-imported as part of a build workflow rather than edited directly.","worth_installing":"Yes, if you need to automate GitHub Pages deployment and are comfortable with dormant maintenance status. The tool is stable and widely used (top 5000 on PyPI), has no known vulnerabilities, and low install friction. Verify compatibility with your current Git version and authentication setup before relying on it in a new CI/CD pipeline."},"id":"ghp-import","links":{"html":"https://skillfed.io/packages/ghp-import","md":"https://skillfed.io/packages/ghp-import.md","pypi":"https://pypi.org/project/ghp-import/"},"maintenance":{"status":"dormant"},"meta":{"latest_release":"2022-05-02","license_spdx":null,"license_treatment":"permissive","name":"ghp-import","python_support":"unspecified","summary":"Copy your docs directly to the gh-pages branch."},"popularity":{"monthly_downloads":17246991,"position":1126,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"2.1.0"}