feat: add initial documentation website #237
Conversation
- Replace Doxygen with MkDocs and Material theme - Add documentation pages (home, installation, quickstart, config, examples) - Set up GitHub Actions for automatic deployment - Note: This is a demo website with placeholder content
- Add MkDocs-based documentation website with Material theme - Include basic pages: Home, Configuration, Examples, Contributing, Releases - Add API documentation structure for Table, Catalog, Schema, Types, and Table Scan - Add build script for local documentation generation - Add GitHub Actions workflow for automatic deployment to GitHub Pages - Configure custom domain cpp.iceberg.apache.org Note: This is a demo version with placeholder content that needs further refinement.
|
- Added Doxygen configuration file for API documentation generation. - Introduced a build script for MkDocs documentation. - Removed outdated documentation files and replaced them with a structured MkDocs setup.
|
|
|
|
@Fokko, could you please take a look at this? |
There was a problem hiding this comment.
Left some small comments, but I think this looks great for a first version! Very comprehensive, thanks @nullccxsy for working on this 🙌
| - name: Install dependencies | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install mkdocs-material |
There was a problem hiding this comment.
Maybe move this to a requirements.txt and slap a version on it. Otherwise, the workflow might break in case of a new version of mkdocs-material that introduces a breaking change.
| - name: Build with MkDocs | ||
| run: | | ||
| cd mkdocs | ||
| mkdocs build --clean |
There was a problem hiding this comment.
How about moving these commands into a Makefile so it can be both invoked by the workflow, but also locally in case you want to iterate quickly.
|
We still see the CI error: https://github.com/apache/iceberg-cpp/actions/runs/17964469116/job/51094065180?pr=237 @Fokko Do you have any idea? |
| ~ under the License. | ||
| --> | ||
|
|
||
| # Documentation |
There was a problem hiding this comment.
Please revert changes on this file
|
@wgtmac I'm not sure, maybe the action is not allowed by the ASF. I would take a look at how we do it at PyIceberg: https://github.com/apache/iceberg-python/blob/main/.github/workflows/python-release-docs.yml Here we just copy the output to the pages branch and set the |
| We aim for high test coverage. Run tests with coverage: | ||
|
|
||
| ```bash | ||
| cmake -S . -B build -DICEBERG_BUILD_COVERAGE=ON |
There was a problem hiding this comment.
We don't have this yet. Perhaps an AI illusion?
|
remote: {"auth_status":"access_denied_to_user","body":"Permission to apache/iceberg-cpp.git denied to github-actions[bot]."} |
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./mkdocs/site | ||
| publish_branch: gh-pages |
Note: This is a demo version with placeholder content that needs further refinement.