ceph/src/Beast/doc/README.md

   1 # Building documentation
   2
   3 ## Specifying Files
   4
   5 To specify the source files for which to build documentation, modify `INPUT`
   6 and its related fields in `doc/source.dox`. Note that the `INPUT` paths are
   7 relative to the `doc/` directory.
   8
   9 ## Install Dependencies
  10
  11 ### Windows
  12
  13 Install these dependencies:
  14
  15 1. Install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html)
  16 2. Download the following zip files from [xsltproc](https://www.zlatkovic.com/pub/libxml/)
  17   (Alternate download: ftp://ftp.zlatkovic.com/libxml/),
  18   and extract the `bin\` folder contents into any folder in your path.
  19   * iconv
  20   * libxml2
  21   * libxslt
  22   * zlib
  23 3. Download [Boost](http://www.boost.org/users/download/)
  24   1. Extract the compressed file contents to your (new) `$BOOST_ROOT` location.
  25   2. Open a command prompt or shell in the `$BOOST_ROOT`.
  26   3. `./bootstrap.bat`
  27   4. If it is not already there, add your `$BOOST_ROOT` to your environment `$PATH`.
  28
  29 ### MacOS
  30
  31 1. Install doxygen:
  32   * Use homebrew to install: `brew install doxygen`.  The executable will be
  33     installed in `/usr/local/bin` which is already in your path.
  34   * Alternatively, install from here: [doxygen](http://www.stack.nl/~dimitri/doxygen/download.html).
  35     You'll then need to make doxygen available to your command line.  You can
  36     do this by adding a symbolic link from `/usr/local/bin` to the doxygen
  37     executable.  For example, `$ ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin/doxygen`
  38 2. Install [Boost](http://www.boost.org/users/download/)
  39   1. Extract the compressed file contents to your (new) `$BOOST_ROOT` location.
  40   2. Open a command prompt or shell in the `$BOOST_ROOT`.
  41   3. `$ ./bootstrap.bat`
  42   4. If it is not already there, add your `$BOOST_ROOT` to your environment
  43      `$PATH`.  This makes the `b2` command available to the command line.
  44 3. That should be all that's required.  In OS X 10.11, at least, libxml2 and
  45    libxslt come pre-installed.
  46
  47 ### Linux
  48
  49 1. Install [Docker](https://docs.docker.com/engine/installation/)
  50 2. Build Docker image. From the Beast root folder:
  51 ```
  52 sudo docker build -t beast-docs doc/
  53 ```
  54
  55 ## Do it
  56
  57 ### Windows & MacOS
  58
  59 From the Beast root folder:
  60 ```
  61 cd doc
  62 ./makeqbk.sh && b2
  63 ```
  64 The output will be in `doc/html`.
  65
  66 ### Linux
  67
  68 From the Beast root folder:
  69 ```
  70 sudo docker run -v $PWD:/opt/beast --rm beast-docs
  71 ```
  72 The output will be in `doc/html`.