Skip to content

Information about documentation in docs #50

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions