search

astropy / sphinx-automodapi

Sphinx extension for generating API documentation
https://sphinx-automodapi.readthedocs.io
BSD 3-Clause "New" or "Revised" License
65 stars 45 forks source link

Always use .rst extension #112

Closed Cadair closed 4 years ago

Cadair commented 4 years ago

I am trying to use automodapi with opsdroid, where we use .md files rather than .rst files as our narrative docs. This means that when we generate api docs with automodapi they get given a .md extension, which is just clearly wrong.

I don't really understand why we are generating ReST files with anything other than a .rst extension?!

codecov[bot] commented 4 years ago

Codecov Report

Merging #112 into master will decrease coverage by 0.01%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #112      +/-   ##
==========================================
- Coverage   87.19%   87.17%   -0.02%     
==========================================
  Files           5        5              
  Lines         695      694       -1     
==========================================
- Hits          606      605       -1     
  Misses         89       89
Impacted Files Coverage Δ
sphinx_automodapi/automodsumm.py 85.71% <ø> (-0.05%) :arrow_down:

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 4c8e33c...c12c14a. Read the comment docs.