Skip to content
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
3 changes: 2 additions & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ jobs:

- name: Install dependencies
run: |
pip install sphinx==6.2.1
cd docs
pip install -r requirements.txt

- name: Build documentation
run: |
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Run pre-commit checks](https://github.com/bd-iaas-us/infiniStore/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/bd-iaas-us/infiniStore/actions/workflows/pre-commit.yml)
[![Slack](https://img.shields.io/badge/Slack-Join%20Us-blue?logo=slack)](https://vllm-dev.slack.com/archives/C07VCUQLE1F)
[![Docs](https://img.shields.io/badge/docs-available-brightgreen)](https://bd-iaas-us.github.io/infiniStore/)
[![Docs](https://img.shields.io/badge/docs-available-brightgreen)](https://bd-iaas-us.github.io/InfiniStore/)


## pre-required
Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
sphinx==6.2.1
sphinx==6.2.1
sphinx_rtd_theme==3.0.2
21 changes: 16 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,31 @@
"sphinx.ext.napoleon",
]


mock_torch = MagicMock(name="torch")
mock_tensor = MagicMock(name="torch.Tensor")
mock__infinistore = MagicMock(name="infinistore._infinistore")
mock_tensor_class = type("Tensor", (object,), {"__module__": "torch"})

mock_torch.Tensor = mock_tensor_class
sys.modules["torch"] = mock_torch
sys.modules["torch.Tensor"] = mock_tensor

mock__infinistore = MagicMock(name="infinistore._infinistore")
sys.modules["infinistore._infinistore"] = mock__infinistore


def skip_member(app, what, name, obj, skip, options):
if name in ["get_kvmap_len", "purge_kv_map", "register_server"]:
return True
return skip


def setup(app):
app.connect("autodoc-skip-member", skip_member)


templates_path = ["_templates"]
exclude_patterns = []

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "alabaster"
html_static_path = ["_static"]
html_theme = "sphinx_rtd_theme"