sphinxcontrib-django icon indicating copy to clipboard operation
sphinxcontrib-django copied to clipboard

This is a sphinx extension which improves the documentation of Django apps.

Results 12 sphinxcontrib-django issues
Sort by recently updated
recently updated
newest added

Bumps the github-actions group with 1 update: [codecov/codecov-action](https://github.com/codecov/codecov-action). Updates `codecov/codecov-action` from 3 to 4 Release notes Sourced from codecov/codecov-action's releases. v4.0.0 v4 of the Codecov Action uses the CLI as...

dependencies

### Short description GitHub Actions: Upgrade to codecov v4 ### Proposed changes - https://github.com/codecov/codecov-action?tab=readme-ov-file#example-workflowyml-with-codecov-action - ### Resolved issues Fixes: #69

### Short description Add more [ruff linting rules](https://docs.astral.sh/ruff/rules). Also `pre-commit autoupdate` ### Proposed changes - - ### Resolved issues Fixes: #65

### Motivation % `ruff --select=DJ ` # https://docs.astral.sh/ruff/rules/django-model-without-dunder-str ``` warning: The top-level linter settings are deprecated in favour of their counterparts in the `lint` section. Please update the following options...

### Motivation Right now when documenting a field with choices, the values of those choices are all that is included. This is frustrating because usually the display name of the...

### Short description Add type annotations to all non-test code. Also configure `ruff` to complain loudly if new code is missing annotations.

If you have a GenericRelation field that uses a deferred string argument rather than an a class argument, documentation build fails with: ``` Extension error (sphinxcontrib_django.docstrings): Handler for event 'autodoc-process-docstring'...

bug

Fixes https://github.com/sphinx-doc/sphinxcontrib-django/issues/43 The tests intended to capture the issue but actually don't trigger the real issue in the test scenario, so they may not be appropriate. I tried making a...

### Motivation I have repos like https://github.com/nexB/purldb/ that hosts multiple django projects (and therefore settings) but has only a single documentation published on RTD https://purldb.readthedocs.io/ I cannot point this plugin...

### Motivation Django 5.0 introduces new methods to define choices (see [Django 5.0 announcement](https://docs.djangoproject.com/en/5.0/releases/5.0/#more-options-for-declaring-field-choices), now choices may be: - an old style list/tuple - a dict - a class which...