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

Warnings generated while generating HTML in docs folder #121

Open
aayush-jaiswal opened this issue Sep 20, 2021 · 3 comments
Open

Warnings generated while generating HTML in docs folder #121

aayush-jaiswal opened this issue Sep 20, 2021 · 3 comments
Labels

Comments

@aayush-jaiswal
Copy link
Contributor

aayush-jaiswal commented Sep 20, 2021

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
@sumit4613
Copy link
Member

@moducodes

@vedantidote
Copy link

Hey I'll be taking a stab at this.

@sumit4613
Copy link
Member

@moducodes Use this command while @aayush-jaiswal is working on to fix this.

$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants