Skip to content

Information about documentation in docs #50

@ots22

Description

@ots22
  • Read the docs builds here: https://empiarreader.readthedocs.io/en/latest/
  • PRs make a preview of how the docs will look on RtD
  • Build docs by hand in usual way for sphinx (NB these instructions may be wrong):
    • make sure pip install empiarreader[doc] is installed (or pip install .[doc] if installing locally)
    • cd into docs
    • make html
    • open index.html in the build directory
  • TODO - note the above in some developer docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions