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

Python documentation #416

Merged
merged 40 commits into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
d706321
Add docstrings
wenwei-dev Jun 9, 2023
95851dd
Add documentation files
wenwei-dev Jun 12, 2023
4b34598
Update docs
wenwei-dev Jun 13, 2023
f45acfd
Generate docstring docs
wenwei-dev Jun 13, 2023
28729a8
Update docs workflow
wenwei-dev Jun 13, 2023
3f438c3
Install deps
wenwei-dev Jun 13, 2023
20b11e9
Update docs workflow
wenwei-dev Jul 14, 2023
a8e5d9b
Create home page
wenwei-dev Jul 24, 2023
8eff29f
Build docs on main
wenwei-dev Aug 10, 2023
2e66af5
Merge docs and doc folders
Aug 13, 2023
dc933ec
Merge branch 'trueagi-io:main' into pydoc
wenwei-dev Aug 18, 2023
51aacb0
Merge remote-tracking branch 'upstream/main' into pydoc
wenwei-dev Aug 23, 2023
09b987d
Add docstrings for atom module
wenwei-dev Aug 23, 2023
8498029
Update docs
wenwei-dev Aug 24, 2023
95aea60
Merge remote-tracking branch 'upstream/main' into pydoc
wenwei-dev Aug 26, 2023
7297551
Update docs
wenwei-dev Aug 27, 2023
2f13b17
Update docs
wenwei-dev Aug 28, 2023
9a1d458
Merge branch 'trueagi-io:main' into pydoc
wenwei-dev Sep 1, 2023
df8a7c9
First batch of docstring revision
glicerico Sep 8, 2023
f82b8ad
Docstring for OperationObject
glicerico Sep 8, 2023
0530c90
More docstrings
glicerico Sep 8, 2023
6886097
More docstrings
glicerico Sep 8, 2023
2af780a
Document register_results
glicerico Sep 8, 2023
e81c585
Fix typos
glicerico Sep 8, 2023
81682fc
Comment base.py
glicerico Sep 8, 2023
08c302e
Address comments
glicerico Sep 14, 2023
b06c5b9
Merge pull request #4 from glicerico/pydoc
wenwei-dev Sep 14, 2023
33bcceb
Merge remote-tracking branch 'upstream/main' into pydoc
wenwei-dev Sep 14, 2023
797715b
Update python/hyperon/atoms.py
Necr0x0Der Sep 14, 2023
8a60a07
Update python/hyperon/atoms.py
Necr0x0Der Sep 14, 2023
bad2fd7
Update python/hyperon/atoms.py
Necr0x0Der Sep 14, 2023
1a854eb
Update python/hyperon/atoms.py
Necr0x0Der Sep 14, 2023
ecabfa7
Update python/hyperon/atoms.py
Necr0x0Der Sep 14, 2023
06e238e
Update python/hyperon/base.py
Necr0x0Der Sep 14, 2023
329a1a9
Update python/hyperon/base.py
Necr0x0Der Sep 14, 2023
955fd83
Update python/hyperon/base.py
Necr0x0Der Sep 14, 2023
fd7088c
Update python/hyperon/base.py
Necr0x0Der Sep 14, 2023
8d5ff9b
Update python/hyperon/base.py
Necr0x0Der Sep 14, 2023
b2aaacf
Update python/hyperon/base.py
Necr0x0Der Sep 14, 2023
5694a80
Update python/hyperon/base.py
Necr0x0Der Sep 14, 2023
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
Prev Previous commit
Next Next commit
Generate docstring docs
  • Loading branch information
wenwei-dev committed Aug 10, 2023
commit f45acfdff5160630b94c74363cc2fec376c31266
2 changes: 2 additions & 0 deletions docs/reference/atoms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Atoms module
::: hyperon.atoms
2 changes: 2 additions & 0 deletions docs/reference/base.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Base module
::: hyperon.base
2 changes: 2 additions & 0 deletions docs/reference/ext.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Ext module
::: hyperon.ext
2 changes: 2 additions & 0 deletions docs/reference/runner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Runner module
::: hyperon.runner
2 changes: 2 additions & 0 deletions docs/reference/stdlib.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Stdlib module
::: hyperon.stdlib
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
mkdocs-minify-plugin
mkdocstrings[python]
14 changes: 13 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,13 @@ plugins:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- minify:
minify_html: true
- mkdocstrings
- mkdocstrings:
handlers:
python:
paths:
- python
- autorefs


extra:
social:
Expand Down Expand Up @@ -111,3 +117,9 @@ markdown_extensions:
# Page tree
nav:
- Home: index.md
- Reference:
- Atoms: reference/atoms.md
- Base: reference/base.md
- Ext: reference/ext.md
- Runner: reference/runner.md
- Stdlib: reference/stdlib.md