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.

Sign up for GitHub

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

test docs build #115

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

test docs build #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
031fe2d
test commit
niksirbi Oct 22, 2024
9f71c06
a minimal API docs example
niksirbi Oct 22, 2024
935833a
include example readme link
niksirbi Oct 22, 2024
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: 2 additions & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
-e .
linkify-it-py
myst-parser
nbsphinx
pydata-sphinx-theme
setuptools-scm
sphinx
sphinx-autodoc-typehints
sphinx-design
sphinx-sitemap
6 changes: 6 additions & 0 deletions docs/source/api_generated/neuralplayground.agents.agent_core.AgentCore.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
neuralplayground.agents.agent\_core.AgentCore
=============================================

.. currentmodule:: neuralplayground.agents.agent_core

.. autoclass:: AgentCore
13 changes: 13 additions & 0 deletions docs/source/api_index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
API
===

Agent
-----

.. currentmodule:: neuralplayground.agents.agent_core

.. autosummary::
:toctree: api_generated
:template: class.rst

AgentCore
2 changes: 2 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
author = "University College London"
try:
release = setuptools_scm.get_version(root="../..", relative_to=__file__)
release = release.split(".dev")[0]
except LookupError:
# if git is not initialised, still allow local build
# with a dummy version
Expand All @@ -44,6 +45,7 @@
"sphinx_sitemap",
"myst_parser",
"nbsphinx",
"sphinx_design",
]

# Configure the myst parser to enable cool markdown features
Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Here you may demonstrate the basic functionalities your package.
You can include code snippets using the usual Markdown syntax:

```python
from my_package import my_function
from NeuralPlayground import my_function

result = my_function()
```
6 changes: 6 additions & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,14 @@ Welcome to NeuralPlayground's documentation!
:maxdepth: 2
:caption: Contents:

installation
getting_started
api_index
readme_link

.. card:: Card Title

Card content

By default the documentation includes the following sections:

Expand Down
3 changes: 3 additions & 0 deletions docs/source/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Install

Do something.
6 changes: 6 additions & 0 deletions docs/source/readme_link.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Readme File
===========

.. include:: ../../README.md
:parser: myst_parser.sphinx_
:start-after: ## Usage
Loading