Blue Brain – NeuroM 3.2.1.dev6 Blue Brain – NeuroM – Building documentation locally 3.2.1.dev6
Type to start searching
    BlueBrain/NeuroM
    BlueBrain/NeuroM
    • Home
    • Quickstart
    • Installation
    • Morphology validation
    • Tutorial
    • Features
    • Spherical coordinates
    • Examples
      • Introduction
      • neurom check: the morphology checker
      • neurom stats: morphometric statistics extraction
    • NeuroM morphology definitions
      • Introduction
      • neurom.morphmath
      • neurom.features
      • neurom.features.population
      • neurom.features.morphology
      • neurom.features.neurite
      • neurom.features.section
      • neurom.features.bifurcation
      • neurom.check.morphtree
      • neurom.check.morphology_checks
      • neurom.core.types
      • neurom.core.morphology
      • neurom.core.population
      • neurom.core.soma
      • neurom.core.dataformat
      • neurom.io.utils
      • neurom.view.dendrogram
      • neurom.view.matplotlib_utils
      • neurom.view.matplotlib_impl
      • neurom.view.plotly_impl
    • Developer Documentation
    • Building documentation locally
    • Migration guides
    • Changelog
    • License

    Building documentation locally¶

    To build documentation, go into project’s doc folder.

    $ cd doc  # assuming that you start from the project's root.
    

    Make sure you have installed into your virtual environment libraries from docs extras: pip install neurom[docs]. Then run the command in the doc folder:

    $ make html
    

    This builds the documentation in doc/build. To view it, open doc/build/html/index.html in a browser.

    Previous Developer Documentation
    Next Migration guides
    Blue Brain Project
    Address
    EPFL/Campus Biotech
    Chemin des Mines 9,
    CH-1202 Geneva
    Switzerland
    © Blue Brain Project/EPFL 2005-2023. All rights reserved.
    Follow the Blue Brain