Skip to content
This repository was archived by the owner on Sep 26, 2022. It is now read-only.
This repository was archived by the owner on Sep 26, 2022. It is now read-only.

Add sphinx for documentation #29

@tkilias

Description

@tkilias

Background

  • Sphinx is a standard documentation system for python https://www.sphinx-doc.org/en/master/
  • It provides documentation generation from reStructuredText or markdown
  • It can generate menus
  • It can generate api documentation from python docstrings
  • It can generate documentation for Readthedocs https://readthedocs.org/

Acceptance Criteria

  • - Have a working setup for sphinx with api documentation generation
  • - Additional contents:
  • - Installation, Usage, Developer Guide
  • - CI tasks which generates the documentation
  • - Optional: get it published on github pages

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureProduct featuresource:exasolIssue was created on behalf of the organization

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions