[MRG] Update documentation and improve coverage by rflamary · Pull Request #160 · PythonOT/POT · GitHub
Skip to content

[MRG] Update documentation and improve coverage#160

Merged
rflamary merged 28 commits into
masterfrom
doc_cov
Apr 28, 2020
Merged

[MRG] Update documentation and improve coverage#160
rflamary merged 28 commits into
masterfrom
doc_cov

Conversation

@rflamary

@rflamary rflamary commented Apr 24, 2020

Copy link
Copy Markdown
Collaborator
  • Correct some dcumentation missing references and math equations alignment
  • Add releases page to documentation
  • Added some tests (mostly partial ot)
  • Put examples in sections and corrected the links in readme.

@rflamary rflamary changed the title [WIP] Update documentation and improve coverage [MRG] Update documentation and improve coverage Apr 24, 2020
@codecov-io

Copy link
Copy Markdown

@rflamary

Copy link
Copy Markdown
Collaborator Author

ok:

doc with new section names + release page:
https://135-71472695-gh.circle-artifacts.com/0/dev/index.html

New gallery with sections :
https://135-71472695-gh.circle-artifacts.com/0/dev/auto_examples/index.html

Also now cross ref with numlpy doc work and there are links. I thoiks i'm done with the doc update.

Sphinx gallery is awesome !

@agramfort

Copy link
Copy Markdown
Collaborator

looking at https://135-71472695-gh.circle-artifacts.com/0/dev/gen_modules/ot.bregman.html#module-ot.bregman you see that many functions are not present in any example. This could be a nice collective effort between all POT contributors

@rflamary

Copy link
Copy Markdown
Collaborator Author

@rflamary rflamary merged commit afedeeb into master Apr 28, 2020
@agramfort agramfort deleted the doc_cov branch April 28, 2020 09:30
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