Build

Raphtory documentations can be found in docs directory. They are built using Sphinx and hosted by readthedocs.

After making your changes, you’re good to build them.

  • Ensure that all development dependencies are already installed.

    $ cd docs && pip install -q -r requirements.txt
    
  • Build rust specific documentation

    $ make rust-build-docs
    
  • Build docs

    $ cd docs && make html
    
  • View docs

    $ open build/html/index.html