Skip to content

Update MkDocs to 8.1.3 #124

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

Merged
merged 2 commits into from
Dec 19, 2021
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
5 changes: 3 additions & 2 deletions docs/en/docs/backends/ormar.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ router = OrmarCRUDRouter(
app.include_router(router)
```

!!! note The `create_schema` should not include the *primary id* field as this be
generated by the database.
!!! note
The `create_schema` should not include the *primary id* field as this be
generated by the database.

## Full Example

Expand Down
10 changes: 2 additions & 8 deletions docs/en/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ contributing, reading the development guidelines below may help you in the proce

## Github

### Issues
#### Issues
Please create an issue to report a bug, request a feature or to simply ask a question.


### Pull Requests
#### Pull Requests
Unless the pull request is a simple bugfix, please try to create an issue before starting on the implementation of your pull request.
This ensures that the potential feature is in alignment with CRUDRouter's goals moving forward. This also allows for feedback
on the feature and potential help on where to start implementation wise.
Expand Down Expand Up @@ -76,9 +76,3 @@ $ mkdocs serve
```

</div>


### Tidbits on Implementation



10 changes: 5 additions & 5 deletions docs/en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ edit_uri: ''

theme:
name: material
# custom_dir: overrides
features:
- navigation.expand
palette:
- scheme: default
primary: indigo
Expand Down Expand Up @@ -41,10 +42,6 @@ nav:
- Contributing: contributing.md
- Releases: releases.md

google_analytics:
- UA-186315536-1
- auto

markdown_extensions:
- extra
- admonition
Expand All @@ -54,6 +51,9 @@ markdown_extensions:
- pymdownx.tabbed

extra:
analytics:
provider: google
property: UA-186315536-1
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/awtkns/fastapi-crudrouter
Expand Down