Skip to content

Conversation

zachborboa
Copy link
Contributor

@pauloxnet
Copy link
Member

It can be interesting to investigate if we can add a test in this PR and also to have an idea of what we'll see in the documentation.

@zachborboa zachborboa force-pushed the main branch 5 times, most recently from 6632832 to a18aa52 Compare October 21, 2022 19:52
@zachborboa
Copy link
Contributor Author

It can be interesting to investigate if we can add a test in this PR and also to have an idea of what we'll see in the documentation.

Tests have been added

@pauloxnet
Copy link
Member

It can be interesting to investigate if we can add a test in this PR and also to have an idea of what we'll see in the documentation.

Tests have been added

Thanks. Can you provide also a screenshot of how it looks ?

@zachborboa
Copy link
Contributor Author

Thanks. Can you provide also a screenshot of how it looks ?

screenshot:
image

@zachborboa zachborboa force-pushed the main branch 4 times, most recently from c66b657 to 63078f5 Compare October 21, 2022 23:43
@zachborboa
Copy link
Contributor Author

Ready for review. Thank you

@smithdc1
Copy link
Member

This ticket on trac seems related to this PR. https://code.djangoproject.com/ticket/29942

@zachborboa
Copy link
Contributor Author

This ticket on trac seems related to this PR. https://code.djangoproject.com/ticket/29942

Agreeing with the ticket. Quite a lot more of the helpful [source] links could be added to the docs when the import failures get fixed.

The errors are currently being silently ignored, but can be unhidden when generating the docs by increasing verbosity:

$ cd django/docs/
$ export SPHINXOPTS="-v"
$ run make html

The solution is to probably install the required modules in the environment where the docs are generated. This would fix errors like missing the psycopg2 module for postgres so that source links to modules like django.contrib.postgres.aggregates.BitAnd are added to sections missing them like https://docs.djangoproject.com/en/dev/ref/contrib/postgres/aggregates/#bitand.

@sarahboyce
Copy link
Contributor

Superseded by #16918

@sarahboyce sarahboyce closed this Jun 1, 2023
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

Successfully merging this pull request may close these issues.

5 participants