conu icon indicating copy to clipboard operation
conu copied to clipboard
verified publisher icon user-cont

Generate docs in conu CI

Open dhodovsk opened this issue 8 years ago • 4 comments

Problem description:

  • we want part of our documentation to be generated by docstring so it is up-to date and method definitions are easily accessible
  • we have c extension in project requirements - might be more in the future - and that can't be installed using pip
  • AFAIK currently readthedocs.io doesn't allow installing packages using installer other than pip

dhodovsk avatar Nov 24 '17 07:11 dhodovsk

Make an easy fix and deal with it later...

dhodovsk avatar Feb 26 '18 13:02 dhodovsk

Create wrapper for pyxattr so the documentation can be generated in readthedocs. https://github.com/dhodovsk/conu/commit/64aa873d86fc763e870f1d4087d4e749e3c41090

dhodovsk avatar Sep 04 '18 08:09 dhodovsk

This should be fixed by #282, so we can start building docs from upstream repository.

rpitonak avatar Sep 19 '18 13:09 rpitonak

Heh, lol, I forgot that xattr was the bad boy :D Dominika, we need you! Come back! I don't think that any of us can configure RTD to build from upstream. We should also likely build docs from the latest release, not git master.

TomasTomecek avatar Sep 19 '18 14:09 TomasTomecek