Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix error with the reference docs not being rendered #31

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

Tinitto
Copy link
Contributor

@Tinitto Tinitto commented Jun 24, 2024

Why

The reference docs were not showing up in the docs site
Fixes #32

What was Done

  • Changed the "all" declarations in the subpackages to be a list of strings instead of classes and modules
  • Added the "syncio" and the "asyncio" modules to the reference.md page explicitly
  • Added the headings for each module in the reference.md page

How to Test

  • Clone the repo
git clone git@github.com:sopherapps/pydantic-redis.git
  • Install dependencies
cd pydantic-redis
python -m venv env
source env/bin/activate
  • Serve the mkdocs site
mkdocs serve

@Tinitto Tinitto merged commit d666225 into master Jun 24, 2024
6 checks passed
@Tinitto Tinitto deleted the hotfix/error-reference-docs-not-visible branch June 24, 2024 10:34
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The Reference Docs from the Docstrings are Not Rendered
1 participant