Skip to content

This repository provides an example of building a documentation website for a Github repository as well as a template for adapting to other projects. Github Pages is the host of the website so that source code management, documentation, and web publishing can be managed on a single platform.

License

Notifications You must be signed in to change notification settings

REF-RAS/sphinx_ghpage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Web Publishing of Documentation for a Github Repository

QUT REF Collection License: GPL v3

Robotics and Autonomous Systems Group, Research Engineering Facility, Research Infrastructure Queensland University of Technology

This repository is an example of a building a documentation website for a Github repository as well as a template for adapting to other projects. The documentation website is hosted on Github Pages so that source code management, documentation, and web publishing can be managed on a single platform.

Please refer to the Tutorial page on how to setup such a website easily.

Author

Dr Andrew Lui, Senior Research Engineer
Robotics and Autonomous Systems, Research Engineering Facility
Research Infrastructure
Queensland University of Technology

Latest update: April 2024

About

This repository provides an example of building a documentation website for a Github repository as well as a template for adapting to other projects. Github Pages is the host of the website so that source code management, documentation, and web publishing can be managed on a single platform.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages