Skip to content

Commit

Permalink
Add internal doc
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 707911189
  • Loading branch information
Conchylicultor authored and The gemma Authors committed Dec 19, 2024
1 parent af38d6e commit c61d261
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py

python:
install:
# `pip install .[docs]` fail: https://github.com/pypa/pip/issues/13092
# So try to install the dependencies separately.
- requirements: docs/requirements.txt
- method: pip
path: .
34 changes: 34 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Copyright 2024 DeepMind Technologies Limited.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Generate documentation.
Usage (from the root directory):
```sh
pip install -e .[docs]
sphinx-build -b html docs/ docs/_build
```
"""

import apitree


apitree.make_project(
# TODO(epot): Add api
modules={},
includes_paths={},
globals=globals(),
)
15 changes: 15 additions & 0 deletions docs/images/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
```{include} ../README.md
```
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx-apitree[ext]

0 comments on commit c61d261

Please sign in to comment.