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

Split requirements for building RTD docs #5112

Closed
dojutsu-user opened this issue Jan 15, 2019 · 8 comments
Closed

Split requirements for building RTD docs #5112

dojutsu-user opened this issue Jan 15, 2019 · 8 comments
Labels
Status: stale Issue will be considered inactive soon

Comments

@dojutsu-user
Copy link
Member

We want to have a separate file requirements/docs.txt which contains the dependencies required for building RTD docs only.

Example: If a virtual environment is created and packges are installed from requirements/docs.txt only and then if the docs are build (located at readthedocs/docs/) with make html command, It should succeed.

This is discussed in PR #5100

@dojutsu-user
Copy link
Member Author

dojutsu-user commented Feb 22, 2019

@humitos
I researched on this issue a bit.
We need to take some design decisions on this.
Turns out that these two lines will go through all the requirements mentioned in INSTALLED_APPS and will raise an error if the app is not found.
https://github.com/rtfd/readthedocs.org/blob/86bfdffaee2a6a5143f6c7c75af2600817101ce1/docs/conf.py#L18-L19
That's the reason, make html command raises ModuleNotFoundError error for the apps starting with celery, dj_pagination, taggit and so on.
Also if these two lines are commented out, this line
https://github.com/rtfd/readthedocs.org/blob/86bfdffaee2a6a5143f6c7c75af2600817101ce1/docs/doc_extensions.py#L18
raises an django.core.exceptions.AppRegistryNotReady error which is legit as django.setup() is required to load the apps.

@dojutsu-user
Copy link
Member Author

Also, doc_extensions.py uses some setting variables from settings which are not accessible without django.setup()

@stale
Copy link

stale bot commented Apr 8, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Apr 8, 2019
@dojutsu-user
Copy link
Member Author

This is still valid I think.

@stale stale bot removed the Status: stale Issue will be considered inactive soon label Apr 9, 2019
@stale
Copy link

stale bot commented May 24, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label May 24, 2019
@dojutsu-user
Copy link
Member Author

@humitos
Is this actionable or should we close it for now?

@stale stale bot removed the Status: stale Issue will be considered inactive soon label May 24, 2019
@stale
Copy link

stale bot commented Jul 8, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Jul 8, 2019
@dojutsu-user dojutsu-user removed the Status: stale Issue will be considered inactive soon label Jul 8, 2019
@stale
Copy link

stale bot commented Aug 22, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Aug 22, 2019
@stale stale bot closed this as completed Aug 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: stale Issue will be considered inactive soon
Projects
None yet
Development

No branches or pull requests

1 participant