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

Docs: Add preprocessor #1114

Merged
merged 23 commits into from
Mar 22, 2024
Merged

Docs: Add preprocessor #1114

merged 23 commits into from
Mar 22, 2024

Conversation

sh-rp
Copy link
Collaborator

@sh-rp sh-rp commented Mar 19, 2024

Description

We want to run all markdown pages through a preprocessor which injects snippets and other links. This will make snippets inserting easier and will remove code duplication for the most part. Re-organizing the snippets will come in a next step.

This PR does the following:

  • Run all .md files in /docs through a preprocessor and saves them to /doc_processed from where they will be served, this folder is not committed to git.
  • Removes the dependency on python for simply starting the docs. The api reference will not be available without explicitly building it. This should make it easier for contributors.

Copy link

netlify bot commented Mar 19, 2024

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit 41fa986
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/65fd42b83deba80008ed5b6a
😎 Deploy Preview https://deploy-preview-1114--dlt-hub-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sh-rp sh-rp force-pushed the d#/process_docs branch from 8631c0e to ab8ee65 Compare March 19, 2024 17:31
@sh-rp sh-rp force-pushed the d#/process_docs branch from ab8ee65 to 44f4d47 Compare March 19, 2024 17:34
@sh-rp sh-rp force-pushed the d#/process_docs branch from 264c6d2 to 67d7994 Compare March 19, 2024 22:57
@sh-rp sh-rp marked this pull request as ready for review March 20, 2024 14:43
Copy link
Contributor

@AstrakhantsevaAA AstrakhantsevaAA left a comment

Choose a reason for hiding this comment

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

Sehr gut!
I love that we don't need to re-generate docs/examples locally before commit

@burnash burnash added the documentation Improvements or additions to documentation label Mar 21, 2024
@sh-rp sh-rp merged commit b626c9b into devel Mar 22, 2024
44 checks passed
@AstrakhantsevaAA AstrakhantsevaAA deleted the d#/process_docs branch March 26, 2024 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants