Published April 18, 2019
| Version 0.4.0
Software
Open
simpeg/discretize: Documentation refactor
Creators
- 1. @simpeg, @geoscixyz, @ubcgif
- 2. @seequent
- 3. Colorado School of Mines - Geophysics - CGEM
- 4. University of British Columbia
- 5. @ColoradoSchoolOfMines
- 6. University of British Columbia, Geophysical Inversion Facility
- 7. Seequent
- 8. QuantifiedCode
Description
- From PR #134
- commits from: @lheagy
- review from: @dccowan
- move base classes to a
basedirectory (closes #128)
- use napoleon + numpy-style docs to compile the docs (closes #126)
- convert existing docstrings to numpy-styled docs
- separate the API documentation from user documentation (closes #127)
- travis cleanup (previously it was confusing which version of python was being used. We used the python 3.6 image on travis but then downloaded the latest conda - which is python 3.7): now each test suite is clearly labeled
- use pytest for testing instead of nose
- content to be developed in the "User Guide" (see #149)
- create a contributor guide (separate pr) that includes info on how we document classes, methods, functions and class attributes (e.g. https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) (see #150)
- pr on SimPEG to ensure it is up-to-date with the changes in the base-class don't cause upstream problems (see simpeg/simpeg#776)
- @leouieda : for your beautiful repo-setup and docs to follow :)
Files
simpeg/discretize-0.4.0.zip
Files
(1.0 MB)
| Name | Size | Download all |
|---|---|---|
|
md5:b89b3efb0748afe94a1ce8a4f100f27a
|
1.0 MB | Preview Download |
Additional details
Related works
- Is supplement to
- https://github.com/simpeg/discretize/tree/0.4.0 (URL)