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: Add documentation for caseinfo and utils (#199) #200

Merged
merged 2 commits into from
Nov 10, 2023
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
2 changes: 1 addition & 1 deletion backend/app/api/api_v1/endpoints/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

from app import schemas
from app.api.deps import current_active_superuser
from app.app.utils import send_test_email
from app.etc.utils import send_test_email

router = APIRouter()

Expand Down
2 changes: 1 addition & 1 deletion backend/app/core/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
from fastapi_users_db_sqlalchemy import SQLAlchemyUserDatabase
from sqlalchemy.ext.asyncio import AsyncSession

from app.app import utils
from app.core.config import settings
from app.core.deps import get_async_session
from app.etc import utils
from app.models.user import OAuthAccount, User


Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import pytest
from starlette.requests import Request

from app.app.utils import send_email, send_test_email, send_user_verify_email
from app.etc.utils import send_email, send_test_email, send_user_verify_email


@pytest.fixture
Expand Down
21 changes: 21 additions & 0 deletions docs/api_api_v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,24 @@ app.api.api_v1.endpoints.bookmarks
:undoc-members:
:show-inheritance:
:private-members:

---------------------------------
app.api.api_v1.endpoints.caseinfo
---------------------------------

.. automodule:: app.api.api_v1.endpoints.caseinfo
:members:
:undoc-members:
:show-inheritance:
:private-members:

------------------------------
app.api.api_v1.endpoints.utils
------------------------------

.. automodule:: app.api.api_v1.endpoints.utils
:members:
:undoc-members:
:show-inheritance:
:private-members:

7 changes: 7 additions & 0 deletions docs/api_models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,10 @@ app.models.user

.. automodule:: app.models.user
:members:

-------------------
app.models.caseinfo
-------------------

.. automodule:: app.models.caseinfo
:members:
Loading