Strange behavior during building docstrings

DenisSidoren commented 2 years ago

Details

Read the Docs project URL: https://readthedocs.org/projects/fedot/
Build URL (if applicable): https://readthedocs.org/projects/fedot/builds/17805926/
Read the Docs username (if applicable): https://readthedocs.org/profiles/Denis_Sidorenko/
Working branch of the project: https://github.com/nccr-itmo/FEDOT/tree/docstrings

Expected Result

Biult documntations by docstrings

Actual Result

Currently, Google-style docstrings can not be built, for example this file looks like this page page in Read the Docs

At this time, spinx-style docsrtings have strange behavior: same style docstrings in this one and the second one were union by Restructured text in the file and finally it looks like this - only one file was built.

stsewd commented 2 years ago

Hi, I see lots of warnings in your build (you can click on each command to see the output)

ImportError: cannot import name 'NoneType' from 'types' (/home/docs/checkouts/readthedocs.org/user_builds/fedot/envs/807/lib/python3.7/types.py)

AttributeError: module 'fedot.core.operations' has no attribute 'model'

Make sure you are using the same python version and requirements on rtd as you have locally, and also make sure to use a path relative to the conf.py file, not the CWD.

https://github.com/nccr-itmo/FEDOT/blob/0fe7146d712f346d681d6952c38ffeae1d8d1f4d/docs/source/conf.py#L16

see https://github.com/readthedocs/readthedocs.org/issues/8105#issuecomment-820610813

DenisSidoren commented 2 years ago

@stsewd thanks a lot! I've fixed warnings, changed path and it works now

readthedocs / readthedocs.org