alteryx/featuretools

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

Open

#2.368 geöffnet am 9. Nov. 2022

Auf GitHub ansehen
 (10 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (853 Forks)batch import
documentationgood first issue

Repository-Metriken

Stars
 (6.895 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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."
`

Contributor Guide

Research-Richtung
Überprüfe, ob das Sphinx Problem https://github.com/sphinx doc/sphinx/issues/10943 geschlossen und behoben ist. Wenn ja, setze die beiden Zeilen in docs/Makefile wie in den Kommentaren angegeben zurück.
Tech Stack
python
Domain
documentation
Issue Type
Wartung
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90