Skip to content

Draft: chore(docs): Attempt to use Pydantic ext for config file #972

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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion .github/workflows/docs-build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
- name: Configure poetry
run: poetry config virtualenvs.in-project true
- name: Install dependencies
run: poetry install --only docs
run: poetry install --with docs
- name: Build documentation
run: make docs
- name: Delete unnecessary files
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
"sphinx.ext.intersphinx",
"sphinx_copybutton",
"sphinx_reredirects",
"sphinxcontrib.autodoc_pydantic",
]

redirects = {
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
..
SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0

############################
Configuration File Reference
############################

.. automodule:: nemoguardrails.rails.llm.config
:members:
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ user-guides/advanced/safeguarding-ai-virtual-assistant-blueprint
:hidden:

architecture/index
configuration
glossary
faqs
```
102 changes: 0 additions & 102 deletions docs/index.rst

This file was deleted.

27 changes: 25 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ sphinx = "<=7.5"
myst-parser = "<=5"
sphinx-copybutton = "<=0.6"
nvidia-sphinx-theme = "*"
autodoc-pydantic = "^2.2.0"


[tool.pytest.ini_options]
Expand Down