[FLINK-39067][docs] Move Python documentation from Hugo to PyDocs#27586
Open
MartijnVisser wants to merge 2 commits intoapache:masterfrom
Open
[FLINK-39067][docs] Move Python documentation from Hugo to PyDocs#27586MartijnVisser wants to merge 2 commits intoapache:masterfrom
MartijnVisser wants to merge 2 commits intoapache:masterfrom
Conversation
Collaborator
74dea2d to
5f5b109
Compare
Contributor
Author
|
@flinkbot run azure |
1 similar comment
Contributor
Author
|
@flinkbot run azure |
5f5b109 to
5de714b
Compare
Migrate Python-specific documentation pages from the main Hugo docs site into the Sphinx-based PyDocs (flink-python/docs/) as part of FLIP-561. This consolidates all Python documentation into a single cohesive location. Changes: - Add user_guide/ section to PyDocs covering Table API, DataStream API, configuration, dependency management, debugging, metrics, FAQs, and Python REPL - Replace moved Hugo pages (English + Chinese) with redirect stubs to preserve backward-compatible URLs - Set up Sphinx i18n with gettext for Chinese translations, including populated .po files from existing Hugo Chinese content - Add language switcher component to PyDocs navbar - Use sphinx.ext.extlinks with FLINK_DOCS_BASE_URL env var for version-configurable cross-references to main Flink docs - Update CI docs.sh to build Chinese PyDocs into zh/ subdirectory - Add sphinx-intl to sphinx dependency group in pyproject.toml - Add Makefile targets for gettext and Chinese docs builds - Update .gitignore for locale build artifacts
- Add Getting Started section with installation and quickstart guides - Add Cookbook section with word count recipe - Add Developer Guide section linking to Flink contributor docs - Add user guide pages: overview, tutorials, performance tuning, state - Add table sub-pages: metrics, operations, python types - Add PyFlink architecture diagrams - Replace configuration page with expanded version - Fix navigation depth to show sub-pages in sidebar - Add make serve target for local development
08b84d3 to
d7a1fd5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
Migrate Python-specific documentation pages from the main Hugo docs site into the Sphinx-based PyDocs (flink-python/docs/) as part of FLIP-561. This consolidates all Python documentation into a single cohesive location.
Brief change log
Verifying this change
PyDocs (English + Chinese)
Then open http://localhost:8080/ and check:
Hugo docs (redirects)
Then at http://localhost:1313/ check:
Does this pull request potentially affect one of the following parts:
@Public(Evolving): (yes / no)Documentation