Skip to content

Issue-3: Docs generation needs to be look into to be on the same standard as tox, pytest , scipy etc.. #164

@alan-techdev

Description

@alan-techdev

We need to look at the docs and make it more professional and useful as per clients feedback

Guide:
Installation
Quickstart
Build your first project(optional)
sphinx extension: autodoc

See existing dmc view on readthedocs
see the restructured document files on dmc view and how this produced the html document on the readthedocs

This should not exceed one week job. (40 hours)

You need to make it as professional as tox, pytest, scipy if possible so learn from others

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions