1
0
Fork 0

Set up for tinygrab from Parrot stubs

deepcrayon
Jeff Moe 2023-12-04 20:52:35 -07:00
parent cf472ad527
commit ad752fc417
6 changed files with 56 additions and 47 deletions

7
.gitignore vendored
View File

@ -47,3 +47,10 @@ outputs_yolov8
wandb
model.safetensors
quickstart.py
# Sphinx
_build/
*.doctrees
*.pickle
*.pot
*.mo

View File

@ -0,0 +1,3 @@
{
"restructuredtext.preview.name": "docutils"
}

View File

@ -4,14 +4,15 @@
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = docs/source
BUILDDIR = docs/build
SOURCEDIR = docs/_source
BUILDDIR = docs/_build
AUTOBUILDOPTS = --host 127.0.0.1 --port 8000 --ignore "*.swp" --ignore "*.swx"
GETTEXT_BUILD = gettext_build
UPDATE_LOCALE = sphinx-intl update -p $(BUILDDIR)/locale/gettext -d $(SOURCEDIR)/locale -l
PO_FILES = $(wildcard docs/source/locale/*/LC_MESSAGES/*.po)
PO_FILES = $(wildcard docs/_source/locale/*/LC_MESSAGES/*.po)
MSGATTRIB = msgattrib
LANGUAGES = am ar bg bn ca cak cs cy da de el en eo es et eu fa fi fil fr he hi hr hu id it ja ko lkt lt lv mk mr ms ne nl no pl pt ro ru si sk sl sq sr sv ta te th tr uk ur vi zh
#LANGUAGES = am ar bg bn ca cak cs cy da de el en eo es et eu fa fi fil fr he hi hr hu id it ja ko lkt lt lv mk mr ms ne nl no pl pt ro ru si sk sl sq sr sv ta te th tr uk ur vi zh
LANGUAGES = en es
.PHONY: check help html livehtml clean_sphinx clean gettext_build update_locale build_html all copy clean_po latex latexpdf
@ -28,7 +29,7 @@ help:
@echo " latex_<lang> Build the documentation using LaTeX for <lang>"
@echo " latexpdf Build the PDFS documentation using LaTeX for all languages"
@echo " latexpdf_<lang> Build the PDFS documentation using LaTeX for <lang>"
@echo " index Copy static docs/index.html to docs/build/html/index.html"
@echo " index Copy static docs/index.html to docs/_build/html/index.html"
all: clean gettext_build update_locale html index
@ -39,7 +40,7 @@ check:
done
index:
cp -p docs/index.html docs/build/html/index.html
cp -p docs/index.html docs/_build/html/index.html
clean:
for file in $(PO_FILES); do \

View File

@ -5,8 +5,8 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
SOURCEDIR = _source
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:

View File

@ -4,11 +4,11 @@ import sys, os
import sphinx.util.logging
logger = sphinx.util.logging.getLogger(__name__)
project = 'Parrot Libre AI IDE'
project = 'tinygrab'
copyright = '2023, Jeff Moe'
author = 'Jeff Moe'
version = "0"
release = '0.0.16'
release = '0.0.1'
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'notfound.extension', 'sphinx.ext.intersphinx']
templates_path = ['_templates']
exclude_patterns = []
@ -26,8 +26,8 @@ python_display_short_literal_types = True
todo_include_todos = False
html_show_copyright = False
html_static_path = ['_static']
html_favicon = '_static/favicon.ico'
html_logo = '_static/logo.png'
#html_favicon = '_static/favicon.ico'
#html_logo = '_static/logo.png'
html_last_updated_fmt: None
html_show_sphinx = False
html_show_sourcelink = False
@ -54,7 +54,8 @@ html_context = {
locale_dirs = ['locale/']
gettext_compact = False
language = 'en'
languages = ('am', 'ar', 'bn', 'de', 'el', 'en', 'eo', 'es', 'eu', 'fil', 'fr', 'he', 'hi', 'id', 'it', 'ja', 'ko', 'mr', 'ms', 'nl', 'pl', 'pt', 'ru', 'see', 'ta', 'te', 'th', 'tr', 'ur', 'vi', 'zh')
#languages = ('am', 'ar', 'bn', 'de', 'el', 'en', 'eo', 'es', 'eu', 'fil', 'fr', 'he', 'hi', 'id', 'it', 'ja', 'ko', 'mr', 'ms', 'nl', 'pl', 'pt', 'ru', 'see', 'ta', 'te', 'th', 'tr', 'ur', 'vi', 'zh')
languages = ('en', 'es')
html_search_language = 'en'
sys.path.insert(0, os.path.abspath('datasets'))

View File

@ -1,48 +1,45 @@
======
Parrot
======
Parrot is a self-hosted Libre AI IDE for stochastic humans.
========
tinygrab
========
`<https://parrot.codes>`_
`<https://spacecruft.org/deepcrayon/tinygrab>`_
``tinygrab`` is a lesser forklet of ``tinygrad``.
``tinygrab`` exists so I can, perchance learn a little about ``tinygrad``,
my nascent AI system, and the glorious Sphinx documentation system.
With docstrings.
.. figure:: _static/screenshots/parrot-screenshot-about.png
:alt: Parrot Screenshot
:width: 90%
Upstream
--------
Most certainly want the upstream repo, not this repo.
See ``README-upstream.md`` for the upstream readme.
Upstream repo:
An IDE is an editor.
It is a software application that makes it easy
for humans to edit computer source code.
* https://github.com/tinygrad/tinygrad
AI adds "artificial intelligence" to the application,
which may help the
human write code.
Libre means all of the source code is under a free software license,
as defined by the Free Software Foundation.
Examples: GPL, MIT.
AI Assistant
------------
Using the Parrot application as a code assistant, with the Phind model,
doctrings and a Sphinx setup was generated.
Libre means all of the AI models are under a free content license
compatible with Wikipedia.
Example: CC by SA, public domain.
* https://parrot.codes
.. note:: Parrot is in early development, not ready for end users.
Human
-----
The typist, blindly following AI instructions.
| Jeff Moe <moe@parrot.codes>
| Loveland, Colorado
.. note:: You want the upstream tinygrad repo, not this one.
.. toctree::
about
screenshots
ide/index
development
build-app
build-docs
extension/index
datasets/index
models/index
source
languages
:maxdepth: 2
:caption: Contents:
.. note:: Parrot documentation is written in English and uses AI machine translation for other languages.