scikit-tda / kepler-mapper

Kepler Mapper: A flexible Python implementation of the Mapper algorithm.

https://kepler-mapper.scikit-tda.org

MIT License

623 stars 180 forks source link

use custom templates for autosummary #219

Closed deargle closed 3 years ago

deargle commented 3 years ago

This lets us tell autosummary to do :members:

also remove docs/reference/stubs from version control, because sphinx rebuilds it automatically

closes #217

deargle commented 3 years ago

Inspired by https://stackoverflow.com/questions/2701998/sphinx-autodoc-is-not-automatic-enough/62613202#62613202

codecov[bot] commented 3 years ago

Codecov Report

Merging #219 (ec49b6b) into master (571b577) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #219   +/-   ##
=======================================
  Coverage   78.61%   78.61%           
=======================================
  Files          11       11           
  Lines         781      781           
  Branches      161      161           
=======================================
  Hits          614      614           
  Misses        138      138           
  Partials       29       29

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 571b577...25e5ef6. Read the comment docs.

deargle commented 3 years ago

Documentation work is strangely simultaneously horrifying and fulfilling. Like teaching!

On Wed, Mar 3, 2021, 7:08 PM Nathaniel Saul notifications@github.com wrote:

@sauln approved this pull request.

Thank you for taking this work on 🙇

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/scikit-tda/kepler-mapper/pull/219#pullrequestreview-603638284, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAI6Y7M5Q4VZXDMMR5GSGCLTB3TSTANCNFSM4YSHMNUQ .