Initializing Documentation (RTD) - Githubissues

mdolab / CMPLXFOIL

GNU General Public License v2.0

29 stars 20 forks source link

Initializing Documentation (RTD) #9

Closed bernardopacini closed 2 years ago

bernardopacini commented 2 years ago

Purpose

This PR adds a documentation page on RTD. The installation guide and citing pages are fully written, however the user guide requires more work.

Type of change

What types of change is it? Select the appropriate type(s) that describe this PR

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (non-backwards-compatible fix or feature)
Code style update (formatting, renaming)
Refactoring (no functional changes, no API changes) X Documentation update
Other (please describe)

Testing

N / A

Checklist

Put an x in the boxes that apply.

[ ] I have run unit and regression tests which pass locally with my changes
[ ] I have added new tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation

bernardopacini commented 2 years ago

This is ready for review. The documentation only covers the installation and citation pages. The user guide page is there, but has no content (apart from a note saying it is under development).