ImperialCollegeLondon / pycsvy

Python reader/writer for CSV files with YAML header information
BSD 3-Clause "New" or "Revised" License
6 stars 7 forks source link

Set up MkDocs #20

Closed AdrianDAlessandro closed 1 year ago

AdrianDAlessandro commented 1 year ago

This PR sets up documentation using MkDocs for this repo. It includes the readme as the home page of the docs and automatically generates reference documentation from the docstrings in the repo.

This fork has a deployed version of the docs at https://adriandalessandro.github.io/pycsvy/

Note that this PR adds the docs requirements as a dependency group in poetry. These groups were introduced in poetry version 1.2.0, which introduces some breaking changes. Most notably the installer has been updated, so to upgrade to poetry 1.2.0 you might have to uninstall it the old way and reinstall it the new way.

Close #15

codecov[bot] commented 1 year ago

Codecov Report

Merging #20 (f0f3f88) into develop (b1e1474) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop      #20   +/-   ##
========================================
  Coverage    92.24%   92.24%           
========================================
  Files            3        3           
  Lines          129      129           
========================================
  Hits           119      119           
  Misses          10       10           
Impacted Files Coverage Δ
csvy/readers.py 91.17% <ø> (ø)
csvy/writers.py 93.10% <ø> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

dalonsoa commented 1 year ago

@all-contributors please add @AdrianDAlessandro for docs

allcontributors[bot] commented 1 year ago

@dalonsoa

I've put up a pull request to add @AdrianDAlessandro! :tada:

dalonsoa commented 1 year ago

@AdrianDAlessandro , now that the fix for mypy is merged, you will need to update this branch to get all tests pass.

AdrianDAlessandro commented 1 year ago

@AdrianDAlessandro , now that the fix for mypy is merged, you will need to update this branch to get all tests pass.

Done