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: auto api reference #642

Merged
merged 16 commits into from
Sep 20, 2023
Merged

Docs: auto api reference #642

merged 16 commits into from
Sep 20, 2023

Conversation

AstrakhantsevaAA
Copy link
Contributor

@AstrakhantsevaAA AstrakhantsevaAA commented Sep 19, 2023

  1. uses pydoc-markdown to render docosaurus reference
  2. reference is rendered when building and committed to the repo, see package.json
  3. placement in Reference/API
  4. uses custom preprocessor which removes #### headers and converts REPL in code blocks
  5. pydoc-markdown installed in docs group with poetry

@netlify
Copy link

netlify bot commented Sep 19, 2023

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit 80828a0
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/650a14d4f4a91700081938a2
😎 Deploy Preview https://deploy-preview-642--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.

@rudolfix rudolfix force-pushed the features/auto-references branch from 6c54d4d to f56ce4f Compare September 19, 2023 20:51
@rudolfix rudolfix force-pushed the features/auto-references branch from f56ce4f to 0ad443c Compare September 19, 2023 20:56
Copy link
Collaborator

@rudolfix rudolfix left a comment

Choose a reason for hiding this comment

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

good as a first version :)

@@ -14,8 +14,8 @@
@configspec
class SchemaStorageConfiguration(BaseConfiguration):
schema_volume_path: str = None # path to volume with default schemas
import_schema_path: Optional[str] = None # import schema from external location
export_schema_path: Optional[str] = None # export schema to external location
import_schema_path: Optional[str] = None # the import schema from external location
Copy link
Collaborator

Choose a reason for hiding this comment

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

why?

@@ -1,3 +0,0 @@
[destination.weaviate]
Copy link
Collaborator

Choose a reason for hiding this comment

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

why it is deleted?

@rudolfix rudolfix merged commit a959598 into devel Sep 20, 2023
38 checks passed
@rudolfix rudolfix deleted the features/auto-references branch September 20, 2023 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants