Add basic docs

[AyanSinhaMahapatra]

1. Adds Basic Sphinx Documentation files
2. Add RTD configuration and requirements file
3. Test Scripts

Signed-off-by: Ayan Sinha Mahapatra ayansmahapatra@gmail.com

[steven-esser]

@AyanSinhaMahapatra This looks good, just a few minor comments.

[AyanSinhaMahapatra]

@MaJuRG I'm not sure why the RTD build is failing would you check - https://readthedocs.org/projects/ayan-fork-nexb-skeleton/builds/12558609/. The requirements install fine, local build also passes. Here are the docs I followed - https://docs.readthedocs.io/en/latest/config-file/v2.html#python

[steven-esser]

@AyanSinhaMahapatra This looks good.

The error the RTD build returns is a problem. This is because a fresh clone of the skeleton repo does not contain a src/ directory that is usually present in an actual library (like extractcode

I think the best approach to solve this issue is to remove this line: https://github.com/nexB/skeleton/blob/ef210cd813de2961fe8ca4a5ec7f14532ea6e9f8/setup.cfg#L23

This will allow the ./configure script and the RTD CI system to run correctly. Once you remove that line and confirm, I will merge this.

[AyanSinhaMahapatra]

Isn't that relevant for the package setup when the src is present? Like users still have to uncomment/use that line when they use the package right?

This is the same error with which the Travis builds for skeleton is failing too.

Would having a src directory here in skeleton, instead, just with a init.py or maybe some dummy functions work instead? That would pass both the failing tests and this RTD build maybe?

[steven-esser]

@AyanSinhaMahapatra Yes that is also a possible solution, though I would prefer to just have minimal README file that just says "put your python modules in this directory" instead of a dummy python file.

[AyanSinhaMahapatra]

@MaJuRG Yeah, that makes more sense. Do you want me to add a commit doing the same here?

[AyanSinhaMahapatra]

RTD build passes, CI tests fail because now even though src is there, no tests are collected by pytest [exit code 5].

[steven-esser]

@AyanSinhaMahapatra I do not really think it matters that the tests do not pass for this skeleton repo (as it is a template, not actual code).

I have removed auto-builds in travis for now for this repo.