scrapinghub / scrapinghub/dateparser

1.0.0: sphinx warnings

Open
#936 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue Type: Documentation
Dominant language
Python
Stars
2.9k
Forks
520
Avg merge
22h 56m
Merged PRs (30d)
6

Description

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.0.2
making output directory... done
WARNING: html_static_path entry '_static' does not exist
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 14 added, 0 changed, 0 removed
reading sources... [100%] usage
/home/tkloczko/rpmbuild/BUILD/dateparser-1.0.0/dateparser/date.py:docstring of dateparser.date.DateDataParser.get_date_data:34: WARNING: Unknown target name: "settings".
WARNING: autodoc: failed to import module 'jalali' from module 'dateparser.calendars'; the following exception was raised:
No module named 'convertdate'
WARNING: autodoc: failed to import module 'detection' from module 'dateparser.languages'; the following exception was raised:
No module named 'dateparser.languages.detection'
WARNING: autodoc: failed to import module 'language' from module 'dateparser.languages'; the following exception was raised:
No module named 'dateparser.languages.language'
/home/tkloczko/rpmbuild/BUILD/dateparser-1.0.0/dateparser/__init__.py:docstring of dateparser:1: WARNING: duplicate object description of dateparser, other instance in dateparser, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/dateparser-1.0.0/dateparser/__init__.py:docstring of dateparser.parse:1: WARNING: duplicate object description of dateparser.parse, other instance in dateparser, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/dateparser-1.0.0/dateparser/__init__.py:docstring of dateparser:1: WARNING: duplicate object description of dateparser, other instance in index, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/dateparser-1.0.0/dateparser/__init__.py:docstring of dateparser.parse:1: WARNING: duplicate object description of dateparser.parse, other instance in index, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/dateparser-1.0.0/dateparser/search/__init__.py:docstring of dateparser.search:1: WARNING: duplicate object description of dateparser.search, other instance in index, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/dateparser-1.0.0/dateparser/search/__init__.py:docstring of dateparser.search.search_dates:1: WARNING: duplicate object description of dateparser.search.search_dates, other instance in index, use :noindex: for one of them
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/tkloczko/rpmbuild/BUILD/dateparser-1.0.0/docs/modules.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/dateparser-1.0.0/docs/template.rst: WARNING: document isn't included in any toctree
done
writing... dateparser.1 { introduction installation usage settings supported_locales contributing authors history } done
build succeeded, 13 warnings.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by rerunning python3 setup.py build_sphinx -b man --build-dir build/sphinx and catalog the 13 warnings. Review docs/modules.rst, docs/template.rst, and the referenced dateparser docstrings and modules, including the missing convertdate dependency. Done means the documentation build no longer emits these warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.