Docs2 - Githubissues

Open-Telecoms-Data / lib-cove-ofds

Other

0 stars 0 forks source link

Docs2 #57

Closed odscjames closed 1 year ago

odscjames commented 1 year ago

https://github.com/Open-Telecoms-Data/lib-cove-ofds/issues/23

This:

Adds intro to whole docs from @duncandewhurst branch
splits into API and CLI sections
new install page, updates instructions
Add info on CLI short aliases
adds Python info on Schema class
adds Python examples
New contributing page - most dev content from readme is now here
Adds more help string to CLI

duncandewhurst commented 1 year ago

Thanks, @odscjames.

I've made the following changes:

Replace README.md with README.rst and include it in docs/index.rst
Add PyPI and Python version badges
Document what is returned by each command
Document additional checks and output format
Document additional fields output format
Refactor docs to reduce repetition and page count

Over to you to review and merge.

duncandewhurst commented 1 year ago

Oh, you can't review your own PR so I'll just merge it.