... | ... | @@ -5,8 +5,8 @@ This page explains how to make your first steps with [Sphinx](https://www.sphinx |
|
|
1. Make sure you have Sphinx installed on your system (see here http://www.sphinx-doc.org/en/master/usage/installation.html)
|
|
|
1. get Kea sources on your laptop: `git clone git@github.com:isc-projects/kea.git`
|
|
|
1. checkout docbook-to-sphinx: `git checkout docbook-to-sphinx`
|
|
|
1. autoreconf -i && ./configure --enable-generate-docs
|
|
|
1. cd doc
|
|
|
1. `autoreconf -i && ./configure --enable-generate-docs` Am afraid you will have to get all the mandatory Kea dependencies for this.
|
|
|
1. `cd doc`
|
|
|
|
|
|
Now you can:
|
|
|
|
... | ... | @@ -30,6 +30,6 @@ If you do your changes on your laptop, make sure you commit and push your change |
|
|
|
|
|
1. Need to improve the Makefiles. @godfryd started and @tomek improved a bit. Need to make sure the .rst files are part of distro tarball.
|
|
|
|
|
|
1. Once the generation works reliably, remote docbook files, update makefiles.
|
|
|
1. Once the generation works reliably, remove docbook files, update makefiles.
|
|
|
|
|
|
1. Make sure the sphinx detection (--with-generate-docs) works properly. It's very basic now. |
|
|
\ No newline at end of file |
|
|
1. Make sure the sphinx detection in configure script (--with-generate-docs) works properly. It's very basic now. |
|
|
\ No newline at end of file |