Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation #170

Open
5 tasks
dalonsoa opened this issue Dec 20, 2024 · 0 comments
Open
5 tasks

Add documentation #170

dalonsoa opened this issue Dec 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation umbrella Issue made of other issues
Milestone

Comments

@dalonsoa
Copy link
Collaborator

dalonsoa commented Dec 20, 2024

Problem

At the moment, all documentation is contained in the README. That worked so far because pycsvy was not doing much. But now, available in both pypi and conda, supporting multiple formats, with multiple input arguments and the availability of header validators - not event mentioned in the README - we need proper documentation in place.

Solution

Implement the documentation using MkDocs and populate it with the relevant sections.

@dalonsoa dalonsoa added documentation Improvements or additions to documentation umbrella Issue made of other issues labels Dec 20, 2024
@dalonsoa dalonsoa added this to the v1.0.0 milestone Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation umbrella Issue made of other issues
Projects
None yet
Development

No branches or pull requests

1 participant