Skip to content

Latest commit

 

History

History
9 lines (8 loc) · 648 Bytes

README.md

File metadata and controls

9 lines (8 loc) · 648 Bytes
Raw

Insolar documentation sources

Install

  1. Install the latest Sphinx version: python3 -m pip install sphinx
  2. Set PATH if you installed it with the --user key: PATH="/Users/<user>/Library/Python/<version>/bin:$PATH"
  3. Install the extensions used in this project: python3 -m pip install sphinx-tabs sphinxcontrib.plantuml sphinx_copybutton sphinxcontrib.contentui

Build

  1. Go to the source files directory: cd <local-path-to-the-repo>/docs/
  2. Build artifacts: make html for HTML artifacts or make latexpdf for PDF artifacts (don't forget to install LaTeX before building PDF artifacts).