101Loop / 101Loop/drf-user

Warnings generated while generating HTML in docs folder

Open
#121 3 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Python
Stars
158
Forks
69
PR merge metrics
No merged PRs in 30d

Description

### Environment
drf-user developer environment

### Description of the bug

When running ```make html``` in docs folder some warnings are generated.

### What you expected to happen

No warnings

### How to reproduce (as minimally and precisely as possible)

- Setup dev environment
- cd docs
- make html

**WARNINGS:**
```
❯ make html
sphinx-build -b html . _build/html
Running Sphinx v4.2.0
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 3 source files that are out of date
updating environment: [new config] 3 added, 0 changed, 0 removed
reading sources... [100%] installation al_settings.py
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:24: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:24: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:24: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:24: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:24: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:49: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:49: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:96: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:96: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:96: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:96: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:96: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:119: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:119: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:119: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:119: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:119: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:151: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:151: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:151: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:151: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:178: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:178: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:178: WARNING: Problem in http domain: field
is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:178: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:207: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:207: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:207: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:231: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:231: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:252: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:259: WARNING: Title underline too short.

**Refresh Token**
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:259: WARNING: Title underline too short.

**Refresh Token**
/home/aayush/Projects/prs/drf-user/docs/api-doc.rst:274: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] installation
generating indices... genindex http-routingtable done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 34 warnings.

The HTML pages are in _build/html.

Build finished. The HTML pages are in _build/html
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.