Skip to content

Commit

Permalink
Python: Split Python docs
Browse files Browse the repository at this point in the history
This PR will split the Python docs in a separate site. The main reason
for this is that the docs are part of the Java release, which is not in
sync with the Python release cylce. Meaning that there is a high probability
that the docs does not match with current version of the code.

This will publish the docs to Github pages, by pushing this to the `gh-pages`
branch. We can set up an alias from Apache, and point pyiceberg.apache.org to
the github pages endpoint.

I also tried readthedocs, but I found that not straightforward. Mostly because
they have a build process on their end that will pull the code, and build the
docs. This involves another pipeline that we have to monitor, and we have to
set up webhooks. I am a simple man, and I like simple things, therefore I went
for mkdocs. This can push the docs to github pages in a single command:
https://www.mkdocs.org/user-guide/deploying-your-docs/#project-pages

Considerations:

- Decided to keep it to a single page for now, we can break it out into different
  pages later on. Let me know what you think of this.
- We build the docs now when we push to master, probably we'll change this
  later to trigger on tags.
- I've removed the Python docs from the other docs to avoid confusion and make sure
  that we have a single source of truth.

An example is shown here: https://fokko.github.io/incubator-iceberg/
(Once this is merged, I'll remove that one)
  • Loading branch information
Fokko committed Sep 8, 2022
1 parent c0f175b commit f0f9680
Show file tree
Hide file tree
Showing 12 changed files with 681 additions and 339 deletions.
2 changes: 2 additions & 0 deletions .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ github:
- SreeramGarlapati
- samredai
- Fokko
ghp_branch: gh-pages
ghp_path: ~

notifications:
commits: commits@iceberg.apache.org
Expand Down
51 changes: 51 additions & 0 deletions .github/workflows/python-ci-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#

name: "Python Docs"
on:
push:
branches:
- 'master'
pull_request:
paths:
- '.github/workflows/python-ci-docs.yml'
- 'python/**'

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
tox:
runs-on: ubuntu-20.04
strategy:
matrix:
python: ['3.8']

steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python }}
- name: Install
working-directory: ./python/docs
run: pip install -r requirements.txt
- name: Deploy
working-directory: ./python/docs
run: mkdocs gh-deploy
184 changes: 0 additions & 184 deletions docs/python-api-intro.md

This file was deleted.

79 changes: 0 additions & 79 deletions docs/python-feature-support.md

This file was deleted.

70 changes: 0 additions & 70 deletions docs/python-quickstart.md

This file was deleted.

Loading

0 comments on commit f0f9680

Please sign in to comment.