Skip to content

Rework api reference in documentation#194

Merged
stefanoborini merged 23 commits into
masterfrom
rework-apidoc
Sep 14, 2016
Merged

Rework api reference in documentation#194
stefanoborini merged 23 commits into
masterfrom
rework-apidoc

Conversation

@itziakos

@itziakos itziakos commented Aug 5, 2016

Copy link
Copy Markdown
Contributor

This PR changes the way the api reference is autogenerated and rendered.

  • The reference documentation is now autogenerated when make html is used and make clean will remove the generated files.
  • The modules that will be rendered are disctated by the developer.rst file.
  • Each module is rendered using a jinja template.
  • The documentation layout is reworked.

note:

  • The code includes a patched version of the autosummary extension that does not try to generate documentation for imported items.

@stefanoborini

Copy link
Copy Markdown
Contributor

Since @itziakos is on vacation, I'll take this over and finish it.

@stefanoborini

Copy link
Copy Markdown
Contributor

Ok, checked issue #195 means that it's in @itziakos hands as a whole. Postponing it.

@codecov-io

codecov-io commented Aug 26, 2016

Copy link
Copy Markdown

Current coverage is 93.28% (diff: 100%)

Merging #194 into master will increase coverage by 0.05%

@@             master       #194   diff @@
==========================================
  Files            73         73          
  Lines          3175       3203    +28   
  Methods           0          0          
  Messages          0          0          
  Branches        209        211     +2   
==========================================
+ Hits           2960       2988    +28   
  Misses          151        151          
  Partials         64         64          

Powered by Codecov. Last update 0b766c7...8d7db21

@stefanoborini

Copy link
Copy Markdown
Contributor

@itziakos The tests now pass. Is this finished?

@itziakos

itziakos commented Sep 5, 2016

Copy link
Copy Markdown
Contributor Author

👍

@stefanoborini

Copy link
Copy Markdown
Contributor

@itziakos I will solve the conflicts and merge it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants