src/bindings/rmr-python/README.rst

   1 rmr-python
   2 ===========
   3
   4 Please see `docs/source/index.rst`
   5
   6 Generating Documentation
   7 ========================
   8
   9 To generate `rmr-python` documentation:
  10
  11 ::
  12
  13     # from the root of rmr-python, not here
  14     docker build -t rmrpythondocs:latest -f Dockerfile-DocGen  .
  15     docker run -v ~/desired/target/dir/:/tmp/docs/build/text rmrpythondocs:latest
  16
  17 After running this, `/desired/target/dir/` will contain `index.rst` and `module_api.txt`