Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Building sphinx docs with dependencies #348

Open
andyneff opened this issue Mar 15, 2021 · 0 comments
Open

Building sphinx docs with dependencies #348

andyneff opened this issue Mar 15, 2021 · 0 comments

Comments

@andyneff
Copy link
Member

Currently, the sphinx plugin creates an environment where sphinx can be built without any extra setup.

However, some docs require extensions beyond what is included by default (such as celery).

A few ideas:

  1. (bad) just give a string of packages that can be installed in the container. Every single time the sphinx container is started, it will pip install these dependencies so that they are available
    • Pro: Easy to implement
    • Con: does not track version of dependencies at all, does not handle needing a different version of python
  2. (bad) Add sphinx as a "dev" package to the project, and mount the virtualenv into the sphinx container
    • Pro: Tracks version of sphinx and its dependencies, for consistent results
    • Con: Would not work. Not only would the venv folder have to be exactly the same path, but so would python, and python libraries in modern virtualenvs, as they are not copies in. Simlinks in the virtualenv would break, this would be extremely fragile if it was ever done this way.
  3. Add sphinx as a "dev" package to the project. Add some extra target to the sphinx plugin to support building "in a local virtual env" and "in a docker compose service" of the project's choosing. Only the "compile" step needs this. Taking compile docs to pdf (which is currently not support anyways I think?) could still be done in the sphix container, so that it could use installed dependencies that may eventually be added.
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

No branches or pull requests

1 participant