alteryx/featuretools

Revert changes for local docs build once related sphinx issue is closed

Open

#2.368 aberto em 9 de nov. de 2022

Ver no GitHub
 (10 comments) (0 reactions) (0 assignees)Python (853 forks)batch import
documentationgood first issue

Métricas do repositório

Stars
 (6.895 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

In MR #2367, changes were made in docs/Makefile to allow docs to be build locally using the make html command. This was needed due to errors that happened when attempting to built the docs with Featuretools installed in editable mode. Docs builds failing in editable mode might be related to an issue with sphinx.

When sphinx issue 10943 (https://github.com/sphinx-doc/sphinx/issues/10943) has been closed and resolved, we should revert the changes that were mode to the Makefile as indicated by the comments here:

.PHONY: html
html:
	# Remove the following line when sphinx issue (https://github.com/sphinx-doc/sphinx/issues/10943) is closed
	python -m pip install .. --quiet --no-dependencies
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html $(SPHINXOPTS)
	# Remove the following line when sphinx issue (https://github.com/sphinx-doc/sphinx/issues/10943) is closed
	python -m pip install -e .. --quiet --no-dependencies
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
`

Guia do colaborador

Direção de pesquisa
Verifique se o problema do sphinx https://github.com/sphinx doc/sphinx/issues/10943 foi fechado e resolvido. Se sim, reverta as duas linhas em docs/Makefile conforme indicado pelos comentários.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Manutenção
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90