https://github.com/paley777/rtd-github-pages

This repository provides a way to automate the creation of documentation for an application.
https://github.com/paley777/rtd-github-pages

documentation readthedocs sphinx-doc

Last synced: 7 days ago
JSON representation

This repository provides a way to automate the creation of documentation for an application.

• Host: GitHub
• URL: https://github.com/paley777/rtd-github-pages
• Owner: paley777
• Created: 2024-05-14T08:11:20.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T14:15:26.000Z (about 2 years ago)
• Last Synced: 2025-02-21T22:45:00.450Z (over 1 year ago)
• Topics: documentation, readthedocs, sphinx-doc
• Language: Python
• Homepage: https://paley777.github.io/rtd-github-pages/
• Size: 2.94 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
                          

Continuous Documentation Repository 💻


This repository provides a way to automate the creation of documentation for an application.




📱 Results in this Link!



 

🚀 Getting started


The process of automating this documentation creation is:

1.Autodoc calls the .py file automatically to generate documentation.

2. Generate documentation (sphinx-docs) automatically when a commit is pushed to the repository.

3. After being generated automatically, the results of the html documentation build are moved to a new branch called "gh-pages".

4. We have set the branch as a Github Pages so that it can be used to host the documentation.

5. All the processes above occur repeatedly when there are changes via push commit automatically. Without the need to change rst files.

Files used:

1. docs_pages_workflow.yml as a file executed by GitHub Actions.

2. buildDocs.sh as a script to build documentation and push it to the "gh-pages" branch.

 

💻 Technologies


- Sphinx Docs

- Read the Docs

- GitHub Actions

- GitHub Pages