Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,18 @@
## 📦 Installation

```bash
pip install datamodel-code-generator
uv tool install datamodel-code-generator
```

<details>
<summary>Other installation methods</summary>

**uv:**
**pip:**
```bash
pip install datamodel-code-generator
```

**uv (add to project):**
```bash
uv add datamodel-code-generator
```
Expand Down
12 changes: 9 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,19 @@

## 📦 Installation

=== "uv tool (Recommended)"

```bash
uv tool install datamodel-code-generator
```

=== "pip"

```bash
pip install datamodel-code-generator
```

=== "uv"
=== "uv (project)"

```bash
uv add datamodel-code-generator
Expand All @@ -37,13 +43,13 @@
conda install -c conda-forge datamodel-code-generator
```

=== "pipx (global)"
=== "pipx"

```bash
pipx install datamodel-code-generator
```

=== "uvx (global)"
=== "uvx (one-shot)"

```bash
uvx datamodel-codegen --help
Expand Down
104 changes: 0 additions & 104 deletions mkdocs.yaml

This file was deleted.

122 changes: 122 additions & 0 deletions zensical.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
[project]
site_name = "datamodel-code-generator"
site_description = "This code generator creates pydantic model from an openapi file and others."
site_url = "https://koxudaxi.github.io/datamodel-code-generator"
repo_name = "koxudaxi/datamodel-code-generator"
repo_url = "https://github.com/koxudaxi/datamodel-code-generator"

nav = [
{ "Overview" = "index.md" },
{ "CLI Reference" = [
{ "Overview" = "cli-reference/index.md" },
{ "Base Options" = "cli-reference/base-options.md" },
{ "Model Customization" = "cli-reference/model-customization.md" },
{ "Field Customization" = "cli-reference/field-customization.md" },
{ "Typing Customization" = "cli-reference/typing-customization.md" },
{ "Template Customization" = "cli-reference/template-customization.md" },
{ "OpenAPI Options" = "cli-reference/openapi-only-options.md" },
{ "General Options" = "cli-reference/general-options.md" },
{ "Utility Options" = "cli-reference/utility-options.md" },
{ "Quick Reference" = "cli-reference/quick-reference.md" }
]},
{ "Support data types" = "supported-data-types.md" },
{ "Usage" = [
{ "Input Formats" = [
{ "OpenAPI" = "openapi.md" },
{ "JSON Schema" = "jsonschema.md" },
{ "JSON Data" = "jsondata.md" },
{ "GraphQL" = "graphql.md" }
]},
{ "Output Customization" = [
{ "Output Model Types" = "what_is_the_difference_between_v1_and_v2.md" },
{ "Model Reuse and Deduplication" = "model-reuse.md" },
{ "Module Structure and Exports" = "module-exports.md" },
{ "Type Mappings and Custom Types" = "type-mappings.md" },
{ "Python Version Compatibility" = "python-version-compatibility.md" },
{ "Root Models and Type Aliases" = "root-model-and-type-alias.md" },
{ "Field Constraints" = "field-constraints.md" },
{ "Field Aliases" = "aliases.md" },
{ "OpenAPI-Specific Options" = "openapi-options.md" }
]},
{ "Templates and Formatting" = [
{ "Custom Templates" = "custom_template.md" },
{ "Custom Formatters" = "custom-formatters.md" },
{ "Code Formatting" = "formatting.md" }
]},
{ "Integration" = [
{ "One-liner Usage" = "oneliner.md" },
{ "Using as Module" = "using_as_module.md" },
{ "pyproject.toml" = "pyproject_toml.md" },
{ "CI/CD Integration" = "ci-cd.md" }
]}
]},
{ "FAQ" = "faq.md" },
{ "Development-Contributing" = "development-contributing.md" },
{ "Changelog" = "changelog.md" }
]

[project.theme]
features = [
"content.code.copy",
"content.code.annotate",
"content.tabs.link",
"navigation.instant",
"navigation.tracking",
"navigation.sections",
"navigation.expand",
"search.highlight",
"search.share",
"toc.follow"
]

[project.theme.icon]
annotation = "material/arrow-right-circle"

[project.theme.analytics]
gtag = "G-0QSKK66WX4"

[[project.theme.palette]]
scheme = "slate"
primary = "light blue"
accent = "light blue"
toggle.icon = "material/brightness-4"
toggle.name = "Switch to light mode"

[[project.theme.palette]]
scheme = "default"
primary = "light blue"
accent = "light blue"
toggle.icon = "material/brightness-7"
toggle.name = "Switch to dark mode"

[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true

[project.markdown_extensions.pymdownx.inlinehilite]

[project.markdown_extensions.pymdownx.snippets]
base_path = "."

[project.markdown_extensions.pymdownx.superfences]

[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true

[project.markdown_extensions.pymdownx.details]

[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg"

[project.markdown_extensions.admonition]

[project.markdown_extensions.attr_list]

[project.markdown_extensions.md_in_html]

[project.markdown_extensions.toc]
permalink = true

[project.plugins.search]
Loading