Skip to content

An example of how the Sphinx-docs template of CodeRefinery can be tuned to host MetOs-realted content.

License

Notifications You must be signed in to change notification settings

MetOs-UiO/sphinx-docs-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Code documentation lesson

Contribution guide

Before filiing a pull-request you should check that the changes introduced by you still make the site build. Therefor, you should always build and test locally before you ask for a pull request.

Usage

Generate from template

If you use this repostitory for your own webpage remember to update the project information in the file PROJECT_ROOT/content/conf.py.

Local build

How to automatically update the documentation locally during development:

$[~/PROJECT_ROOT] sphinx-autobuild content/ _build

The static webpage is hosted on Github and automatically build be pushing changes to the main branch. The build web-page is displayed as the stuff build on the gh-pages branch. This process is automatic. A guide to the principles can be found here.

About

An example of how the Sphinx-docs template of CodeRefinery can be tuned to host MetOs-realted content.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published