The process for building the documention is:
- Run
rstgenwhich does the following:- Generates all of the source reference ReST files.
- Generates the
aws_man_pages.jsonfile which contains the list of all man pages to be generated as needed byconf.py. - Generates
tutorial/services.rstwhich is included bytutorial/getting_started.rst.
- Run
make htmlwhich will build all of the HTML documentation into thebuild/htmldirectory. - Run
make manwhich will build all of the man pages into../doc/man/man1. These files are included in the source distribution and installed bypython setup.py install. - Run
make textwhich will build all of the text pages that are used for interactive help on the Window platform. These files are included in the source distribution and installed bypython setup.py install.
You can perform all of these tasks by running make all in this
directory. If you have previously built the documentation and want
to regenerate it, run make clean first.