Use package directly on sphinx conf - Githubissues

DAI-Lab / cookiecutter-pypackage

DAI Lab's adaptation of cookiecutter-pypackage

BSD 3-Clause "New" or "Revised" License

1 stars 5 forks source link

Use package directly on sphinx conf #28

Closed micahjsmith closed 4 years ago

micahjsmith commented 5 years ago

We observe that when we build docs, we have already installed the package using make install-develop or similar, so the package that we are building docs for has already been installed.

adding to sys.path in sphinx conf.py is not necessary, instead, can import project_slug directly
create variables for general information about the project and re-use these for configuring other sphinx output formats (see https://github.com/HDI-Project/ATM/blob/master/docs/conf.py#L54)