Package and deploy the extension

[rw1nkler]

This PR creates the package with the sphinx-verilog-domain and adds the ability to deploy it to PyPI using Travis CI.

Additionally, the following changes were introduced:

• Added make-env for environment management
• Added basic Sphinx documentation structure
• All the tests have been moved to Sphinx documentation

The PR requires proper token setup for PyPI

Resolves #6

[mithro]

This should reference the local package, otherwise it will be downloaded from PyPi?

Suggested change

	sphinxcontrib-verilog-diagrams
	-e ../

[rw1nkler]

This is about sphinxcontrib-verilog-diagrams not about sphinx-verilog-domain.

Nevertheless, the relative dependencies are not handled properly by conda. If you add the -e ../ to the requirements file, the main environment (created by make-env) will not be created. Conda seems to handle relative dependencies in the requirements file, as a relative to the environment.yml not to the requirements file itself:

Pip subprocess error:
ERROR: File "setup.py" not found. Directory cannot be installed in editable mode: /mnt/hdd1//verilog_domain_ws

The repository is placed in:

/mnt/hdd1/verilog_domain_ws/sphinx-verilog-domain

The sphinx-verilog-domain package is installed in the environment.yml directly.
Since the RTD build also uses conda and the documentation build should happen inside this environment, I think that the -e ../ can be omitted in the docs/requirements.txt

[rw1nkler]

@mithro do you agree to left those files in that way? The problem with this convention will never occur unless somebody will decide to build the documentation without using make-env for this repository. This is exactly the same way as it is done for sphinxcontrib-verilog-diagrams.

[mithro]

@rw1nkler - I was sure that I had solved this somewhere...

[mithro]

There is a bunch of discussion at pypa/pip#328

[rw1nkler]

It seems that this problem is not resolved for the requirements.txt (It will be fixed by the pipfile):

• Requirements file which contains -e with a relative local path, is only installable from a specific directory pypa/pip#6112
• Requirements 2.0 pypa/pip#1795

As I said before, the problem with the current settings will happen only if somebody will build the docs outside the make-env environment, which is generally wrong. I think that we should leave the requirements file as they are now.

[mithro]

Just one comment.

Poke me after merging and I'll add the token needed to upload to PyPi.

[rw1nkler]

@mithro It seems that the problem with the editable packages installed within nested requirements.txt files is still unresolved. However, it should not affect documentation building and package development unless somebody will decide not to use make-env for this repository and install packages manually.

[rw1nkler]

@mithro Can we merge this PR?