Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for publishing documentation #28

Merged
merged 1 commit into from
Aug 21, 2022
Merged

Conversation

kou
Copy link
Member

@kou kou commented Aug 21, 2022

fix #27

Documentation URLs:

Documentation tools:

  • /
    • Sphinx
      • Base contents and layout
      • Theme: pydata_sphinx_theme
    • Doxygen
      • DataFusion C's API reference
      • Comments for Doxygen are written in src/capi.rs
      • Integrated into Sphinx by Breathe
  • /glib/
    • Gi-DocGen
      • No sphinx integration
      • Just hyper linked each other

Deployment:

  • The gh-pages branch is used
  • The gh-pages branch is updated automatically by GitHub Actions
@kou kou force-pushed the doc branch 6 times, most recently from 798ee2a to 4c1bbe3 Compare August 21, 2022 13:46
fix datafusion-contrib#27

Documentation URLs:

  * https://datafusion-contrib.github.io/datafusion-c/
    * Redirect to https://datafusion-contrib.github.io/datafusion-c/latest/
  * https://datafusion-contrib.github.io/datafusion-c/${VERSION}/
    * Documentation for ${VERSION}
  * https://datafusion-contrib.github.io/datafusion-c/latest/
    * Copy of the latest
      https://datafusion-contrib.github.io/datafusion-c/${VERSION}/
  * https://datafusion-contrib.github.io/datafusion-c/main/
    * Documentation for the main branch

Documentation tools:

  * /
    * Sphinx
      * Base contents and layout
      * Theme: pydata_sphinx_theme
    * Doxygen
      * DataFusion C's API reference
      * Comments for Doxygen are written in src/capi.rs
      * Integrated into Sphinx by Breathe
  * /glib/
    * Gi-DocGen
      * No sphinx integration
      * Just hyper linked each other

Deployment:

  * The gh-pages branch is used
  * The gh-pages branch is updated automatically by GitHub Actions
@kou kou merged commit eeb2644 into datafusion-contrib:main Aug 21, 2022
@kou kou deleted the doc branch August 21, 2022 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
1 participant