You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
(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
(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.
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.
The text was updated successfully, but these errors were encountered:
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:
The text was updated successfully, but these errors were encountered: