https://github.com/rggh/jubilant-lamp

Automatic Python Documentation built with Sphinx and GitHub Actions hosted on GitHub Pages
https://github.com/rggh/jubilant-lamp

documentation-generator gh-pages ghp-import github-actions github-pages sphinx sphinx-apidoc

Last synced: about 1 month ago
JSON representation

Automatic Python Documentation built with Sphinx and GitHub Actions hosted on GitHub Pages

• Host: GitHub
• URL: https://github.com/rggh/jubilant-lamp
• Owner: RGGH
• Created: 2023-03-18T20:04:10.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-25T11:54:38.000Z (about 3 years ago)
• Last Synced: 2025-03-28T01:55:30.587Z (about 1 year ago)
• Topics: documentation-generator, gh-pages, ghp-import, github-actions, github-pages, sphinx, sphinx-apidoc
• Language: Python
• Homepage: https://rggh.github.io/jubilant-lamp/
• Size: 2.82 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Sphinx > GitHub Actions > Pages

![example workflow](https://github.com/RGGH/ghp2/actions/workflows/sphinx.yml/badge.svg)

### [jubilantlamp](https://rggh.github.io/jubilant-lamp/)

- click settings to enable github pages : https://docs.github.com/en/pages/quickstart

- add workflow permissions : https://github.com/ad-m/github-push-action/issues/96#issuecomment-889984928

- to use this as a base, use : git remote remove origin so you can start a new repo


  eg : git remote add origin https://github.com/RGGH/the-new-repo-name.git

- The workflow action uses `pip install ghp-import`

- The yaml file uses 'master' not main

- [Full Article and Tutorial on the redandgreen website](https://redandgreen.co.uk/sphinx-to-github-pages-via-github-actions/)

[buymeacoffee](https://www.buymeacoffee.com/DrPi)