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.

Sign up for GitHub

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

Jump to bottom

chore(docs): Setup docs publishing to GitHub Pages #832

Merged
merged 9 commits into from
Feb 16, 2024
Merged

chore(docs): Setup docs publishing to GitHub Pages #832

merged 9 commits into from
Feb 16, 2024

Conversation

setu4993
Copy link
Member

Shortcut: https://app.shortcut.com/galileo/story/12701/dq-move-docs-to-github-pages

Description: I'm refactoring how we build the docs to make it cleaner and less hard-coded. We're also moving the publishing of the docs to GitHub Pages to http://dataquality.docs.rungalileo.io/.

Changes:

  • chore: Remove autodocs dir
  • chore(deps): Add autodoc-pydantic
  • chore: Update docs generation task to generate HTML output
  • chore: Update docs config
  • feat: Add logo
  • chore: Ignore docs build output
  • chore: Generate docs source files
  • chore: Update docs workflow to write to dataquality-docs

Tests:

  • Local.
Screenshot 2024-02-15 at 7 32 30 PM

@setu4993 setu4993 requested review from dcaustin33 and a team as code owners February 16, 2024 03:33
setu4993
setu4993 commented Feb 16, 2024
View reviewed changes
.github/workflows/publish-docs.yaml
@@ -0,0 +1,48 @@
name: Publish Docs
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This helps align the workflow to our other repos. I renamed the file but git thinks I deleted and created a new one 🤷🏽‍♂️.

docs/source/conf.py
@@ -0,0 +1,59 @@
# Configuration file for the Sphinx documentation builder.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This matches most of the old config but removes redundant pieces and cleans it up a bit.

docs/source/dataquality.clients.rst
@@ -0,0 +1,29 @@
dataquality.clients package
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of the RST files are auto-generated.

pyproject.toml
@@ -65,7 +65,8 @@ doc = [
"myst-parser",
"sphinx-markdown-builder",
"sphinx-autobuild",
"sphinx-markdown-builder"
"sphinx-markdown-builder",
"autodoc-pydantic"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this package.

tasks.py
)
ctx.run("sphinx-apidoc -f -o docs/source/ dataquality/", pty=True, echo=True)
ctx.run("sphinx-build -M markdown docs/source docs/build/md", echo=True)
ctx.run("sphinx-build -b html docs/source/ docs/build/html", echo=True)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got rid of the Makefile and just writing down the actual command we need.

@setu4993
Copy link
Member Author

https://app.shortcut.com/galileo/story/12701/dq-move-docs-to-github-pages

@shortcut-integration Shortcut Integration
Copy link

This pull request has been linked to Shortcut Story #12701: [dq] Move docs to GitHub pages.

@codecov Codecov
Copy link

codecov bot commented Feb 16, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (42e5e13) 86.37% compared to head (8563812) 86.40%.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #832      +/-   ##
==========================================
+ Coverage   86.37%   86.40%   +0.02%     
==========================================
  Files         196      196              
  Lines       15836    15848      +12     
==========================================
+ Hits        13679    13694      +15     
+ Misses       2157     2154       -3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

elboy3
elboy3 approved these changes Feb 16, 2024
View reviewed changes
Copy link
Contributor

@elboy3 elboy3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this replace sphinx? Would love to get rid of that

@setu4993
Copy link
Member Author

Does this replace sphinx? Would love to get rid of that

It uses Sphinx. Curious why?

@setu4993 setu4993 merged commit bb47710 into main Feb 16, 2024
5 checks passed
@setu4993 setu4993 deleted the chore/docs/gh-pages branch February 16, 2024 16:25
@setu4993 setu4993 mentioned this pull request Feb 16, 2024
Merged
setu4993 added a commit that referenced this pull request Feb 16, 2024
@setu4993
ci(docs): Disable running with workflow_dispatch since this is a pu…
6a66d1f 
…blic repo (#834)

**Description:** `workflow_dispatch` is a terrible idea when in a public
repo.

I had added it so that I could debug in case the run after #832 failed.
It didn't so we can remove it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elboy3 elboy3 elboy3 approved these changes

@dcaustin33 dcaustin33 Awaiting requested review from dcaustin33

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@setu4993 @elboy3