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

build-docs.sh not exactly the same as Read the Docs #3132

Closed
astrojuanlu opened this issue Oct 5, 2023 · 3 comments
Closed

build-docs.sh not exactly the same as Read the Docs #3132

astrojuanlu opened this issue Oct 5, 2023 · 3 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation good first issue Good first issues for beginners

Comments

@astrojuanlu
Copy link
Member

For some time I have been unable to build the docs locally, but I've been ignoring the issue because Read the Docs was working fine. This was reported by @lrcouto when she started however.

Now I paid more attention and noticed that build-docs.sh (hence make build-docs) does

sphinx-build -WETa -j auto -D language=en -b html -d docs/build/doctrees docs/source docs/build/html

whereas RTD does the equivalent of

python -m sphinx -WET --keep-going -D language=en -b html -d docs/build/doctrees docs/source docs/build/html

Key thing being --keep-going:

--keep-going      with -W, keep going when getting warnings

(so, even if warnings are treated as errors, at least the build proceeds)

I think Sphinx is obscure enough that we can just add --keep-going to our script so that contributors can just not worry about this.

@astrojuanlu astrojuanlu added Component: Documentation 📄 Issue/PR for markdown and API documentation good first issue Good first issues for beginners Hacktoberfest labels Oct 5, 2023
@Celsuss
Copy link
Contributor

Celsuss commented Oct 6, 2023

I can take a look at this.

@Celsuss
Copy link
Contributor

Celsuss commented Oct 6, 2023

I found a problem while working with this.
The Guidelines for contributing developers says that kedro supports python>=3.7, however when trying to run make build-docs with python3.7 I get the error.

ERROR: Cannot install kedro-datasets[all]==1.7.0 and kedro-datasets[all]==1.7.1 because these package versions have conflicting dependencies.

The conflict is caused by:
    kedro-datasets[all] 1.7.1 depends on snowflake-snowpark-python~=1.0.0; extra == "all"
    kedro-datasets[all] 1.7.0 depends on snowflake-snowpark-python~=1.0.0; extra == "all"

To fix this you could try to:
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict

ERROR: ResolutionImpossible: for help visit https://pip.pypa.io/en/latest/topics/dependency-resolution/#dealing-with-dependency-conflicts
make: *** [Makefile:39: build-docs] Error 1

Looking at snowflake-snowpark-python documentation it says it only supports python>=3.8.
Upgrading to python 3.8 fixed the problem.

@stichbury
Copy link
Contributor

Thanks for this Hacktoberfest contribution @Celsuss -- it's merged now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation good first issue Good first issues for beginners
Projects
Archived in project
Development

No branches or pull requests

3 participants