apache / apache/airflow

Docs feature: auto-build documentation

Open
#33,553 1 comment 0 reactions 0 assignees View on GitHub
kind:documentation kind:feature
Dominant language
Python
Stars
46.9k
Forks
17.8k
Avg merge
2d 7h
Merged PRs (30d)
484

Description

### What do you see as an issue?

It currently takes a few minutes each time to build the docs. So, each small mistake requires a few minutes to wait for the docs to re-build.

### Solving the problem

I tried using [sphinx-autobuild](https://github.com/executablebooks/sphinx-autobuild), but I haven't been able to get it to work.

### Anything else

I'd be happy to work on a PR with someone who knows restructured text/sphinx better than I do.

### Are you willing to submit PR?

- [ ] Yes I am willing to submit a PR!

### Code of Conduct

- [X] I agree to follow this project's [Code of Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the repository's documentation build setup and the linked sphinx-autobuild project. Determine how the docs are currently built and define a workflow that rebuilds them automatically after source changes; done means small documentation edits can be checked without manually restarting a full build.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.