a b/docs/README.md 

  1
  
# Documentation





  
  

  2
  





  
  

  3
  
The source for BPNet documentation is in this directory under `sources/`. 





  
  

  4
  
Our documentation uses extended Markdown, as implemented by [MkDocs](http://mkdocs.org) and wrapped by Keras.





  
  

  5
  





  
  

  6
  
## Building the documentation





  
  

  7
  





  
  

  8
  
- Install MkDocs: `pip install mkdocs`





  
  

  9
  
- If you are on OS-x, install `gnu-sed` from conda-forge `conda install -c conda-forge sed`. Make sure that `which sed` returns the right path.





  
  

  10
  
- `cd` to the `docs/` folder and run:





  
  

  11
  
    - `make build`      # Builds a static site in "site" directory





  
  

  12
  
      - injects the docstrings into placeholders. See `docs/autogen.py` and `docs/templates/api/model.md`





  
  

  13
  
      - converts the ipynbs (`docs/ipynb_pages.txt`) to .md





  
  

  14
  
      - Converts the .md files to a static page. See `docs/mkdocs.yml`





  
  

  15
  
    - `mkdocs serve`    # Starts a local webserver:  [localhost:8000](localhost:8000)