meson/docs/README.md

# Building the documentation

1. Get [hotdoc](https://hotdoc.github.io/installing.html) (0.8.9 required)
1. Run hotdoc in the docs/ directory:

    ../meson/meson.py build/

## Upload

We are using the git-upload hotdoc plugin which basically
removes the html pages and replaces with the new content.

You can simply run:

    ninja -C build/ upload
docs: Import the website and wiki and build with hotdoc This allows us to more easily have the documentation in sync with the source code as people will have to document new features etc right at the time where they implement it. 2017-03-30 02:03:43 +08:00			`# Building the documentation`

			`1. Get [hotdoc](https://hotdoc.github.io/installing.html) (0.8.9 required)`
docs: clarify where hotdoc should be run 2017-05-09 08:11:47 +08:00			`1. Run hotdoc in the docs/ directory:`
docs: Import the website and wiki and build with hotdoc This allows us to more easily have the documentation in sync with the source code as people will have to document new features etc right at the time where they implement it. 2017-03-30 02:03:43 +08:00
docs: Use meson to build documentation Let's eat our own dogfood. 2018-08-15 03:04:48 +08:00			`../meson/meson.py build/`
docs: Import the website and wiki and build with hotdoc This allows us to more easily have the documentation in sync with the source code as people will have to document new features etc right at the time where they implement it. 2017-03-30 02:03:43 +08:00
			`## Upload`

			`We are using the git-upload hotdoc plugin which basically`
			`removes the html pages and replaces with the new content.`

			`You can simply run:`

docs: Use meson to build documentation Let's eat our own dogfood. 2018-08-15 03:04:48 +08:00			`ninja -C build/ upload`