Skip to content

Fix - modules documentation are not generated properly #553

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 5 commits into from
Oct 11, 2022
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
18 changes: 3 additions & 15 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ jobs:
- name: Install pipenv
uses: dschep/install-pipenv-action@v1
- name: Install dependencies
run: pipenv install --dev
- name: Build docs
run: pipenv install --dev
- name: Build docs
uses: ammaraskar/sphinx-action@master
with:
pre-build-command: "pip install sphinx_rtd_theme && sphinx-apidoc -f -o docs meilisearch/"
Expand All @@ -30,16 +30,4 @@ jobs:
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
force_orphan: true












force_orphan: true
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []
html_static_path = []

# This value contains a list of modules to be mocked up.
autodoc_mock_imports = ["camel_converter"]
16 changes: 16 additions & 0 deletions docs/meilisearch.models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ meilisearch.models package
Submodules
----------

meilisearch.models.client module
--------------------------------

.. automodule:: meilisearch.models.client
:members:
:undoc-members:
:show-inheritance:

meilisearch.models.document module
----------------------------------

Expand All @@ -20,6 +28,14 @@ meilisearch.models.index module
:undoc-members:
:show-inheritance:

meilisearch.models.ressource module
-----------------------------------

.. automodule:: meilisearch.models.ressource
:members:
:undoc-members:
:show-inheritance:

meilisearch.models.task module
------------------------------

Expand Down