mirror of
https://github.com/Zandercraft/Aurora-lang.git
synced 2026-10-30 04:49:21 +00:00
Initial docs
This commit is contained in:
19
aurora.py
19
aurora.py
@@ -1,12 +1,11 @@
|
|||||||
|
# d888888
|
||||||
|
# d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
||||||
|
# d88P aaa 888 888 888P d88^^88b 888P 88b
|
||||||
|
# d88P aaa 888 888 888 888 888 888 .d888888
|
||||||
|
# d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
||||||
|
# d88P aaa Y88888 888 Y88P 888 Y888888
|
||||||
|
# -- Copyright © 2023 Zandercraft. All rights reserved. --
|
||||||
"""
|
"""
|
||||||
d888888
|
|
||||||
d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
|
||||||
d88P aaa 888 888 888P d88^^88b 888P 88b
|
|
||||||
d88P aaa 888 888 888 888 888 888 .d888888
|
|
||||||
d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
|
||||||
d88P aaa Y88888 888 Y88P 888 Y888888
|
|
||||||
-- Copyright © 2023 Zandercraft. All rights reserved. --
|
|
||||||
|
|
||||||
Purpose: Main implementation of Aurora
|
Purpose: Main implementation of Aurora
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -738,7 +737,7 @@ class Number:
|
|||||||
return Number(1 if self.value == 0 else 0).set_context(self.context), None
|
return Number(1 if self.value == 0 else 0).set_context(self.context), None
|
||||||
|
|
||||||
def is_true(self):
|
def is_true(self):
|
||||||
return self.value != 0
|
return self.value not in (0, -1)
|
||||||
|
|
||||||
def copy(self):
|
def copy(self):
|
||||||
copy = Number(self.value)
|
copy = Number(self.value)
|
||||||
@@ -910,7 +909,7 @@ class Interpreter:
|
|||||||
# RUNNER
|
# RUNNER
|
||||||
####################
|
####################
|
||||||
global_symbol_table = SymbolTable()
|
global_symbol_table = SymbolTable()
|
||||||
global_symbol_table.set("null", Number(0))
|
global_symbol_table.set("null", Number(-1))
|
||||||
global_symbol_table.set("true", Number(1))
|
global_symbol_table.set("true", Number(1))
|
||||||
global_symbol_table.set("false", Number(0))
|
global_symbol_table.set("false", Number(0))
|
||||||
|
|
||||||
|
|||||||
20
docs/Makefile
Normal file
20
docs/Makefile
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Minimal makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line, and also
|
||||||
|
# from the environment for the first two.
|
||||||
|
SPHINXOPTS ?=
|
||||||
|
SPHINXBUILD ?= sphinx-build
|
||||||
|
SOURCEDIR = .
|
||||||
|
BUILDDIR = _build
|
||||||
|
|
||||||
|
# Put it first so that "make" without argument is like "make help".
|
||||||
|
help:
|
||||||
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
||||||
|
.PHONY: help Makefile
|
||||||
|
|
||||||
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
|
%: Makefile
|
||||||
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
7
docs/aurora.rst
Normal file
7
docs/aurora.rst
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
aurora module
|
||||||
|
=============
|
||||||
|
|
||||||
|
.. automodule:: aurora
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
39
docs/conf.py
Normal file
39
docs/conf.py
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# Configuration file for the Sphinx documentation builder.
|
||||||
|
#
|
||||||
|
# For the full list of built-in configuration values, see the documentation:
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||||
|
|
||||||
|
# -- Project information -----------------------------------------------------
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||||
|
|
||||||
|
# Imports
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
|
sys.path.insert(0, os.path.abspath('..'))
|
||||||
|
|
||||||
|
project = 'Aurora'
|
||||||
|
copyright = '2023, Zandercraft, Zander M.'
|
||||||
|
author = 'Zandercraft, Zander M.'
|
||||||
|
release = '0.0.1-dev1'
|
||||||
|
|
||||||
|
# -- General configuration ---------------------------------------------------
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||||
|
|
||||||
|
extensions = [
|
||||||
|
'sphinx.ext.autodoc',
|
||||||
|
'sphinx.ext.viewcode',
|
||||||
|
'sphinx.ext.napoleon'
|
||||||
|
]
|
||||||
|
|
||||||
|
templates_path = ['_templates']
|
||||||
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||||
|
|
||||||
|
# -- Options for HTML output -------------------------------------------------
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||||
|
|
||||||
|
html_theme = 'sphinx_rtd_theme'
|
||||||
|
html_static_path = ['_static']
|
||||||
10
docs/exceptions.rst
Normal file
10
docs/exceptions.rst
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
exceptions package
|
||||||
|
==================
|
||||||
|
|
||||||
|
Module contents
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. automodule:: exceptions
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
22
docs/index.rst
Normal file
22
docs/index.rst
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
.. Aurora documentation master file, created by
|
||||||
|
sphinx-quickstart on Tue Apr 4 17:57:29 2023.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Welcome to Aurora's documentation!
|
||||||
|
==================================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:caption: Contents
|
||||||
|
|
||||||
|
modules
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
==================
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
21
docs/internal.rst
Normal file
21
docs/internal.rst
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
internal package
|
||||||
|
================
|
||||||
|
|
||||||
|
Submodules
|
||||||
|
----------
|
||||||
|
|
||||||
|
internal.term\_utils module
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. automodule:: internal.term_utils
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
Module contents
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. automodule:: internal
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
7
docs/main.rst
Normal file
7
docs/main.rst
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
main module
|
||||||
|
===========
|
||||||
|
|
||||||
|
.. automodule:: main
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
35
docs/make.bat
Normal file
35
docs/make.bat
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
@ECHO OFF
|
||||||
|
|
||||||
|
pushd %~dp0
|
||||||
|
|
||||||
|
REM Command file for Sphinx documentation
|
||||||
|
|
||||||
|
if "%SPHINXBUILD%" == "" (
|
||||||
|
set SPHINXBUILD=sphinx-build
|
||||||
|
)
|
||||||
|
set SOURCEDIR=.
|
||||||
|
set BUILDDIR=_build
|
||||||
|
|
||||||
|
%SPHINXBUILD% >NUL 2>NUL
|
||||||
|
if errorlevel 9009 (
|
||||||
|
echo.
|
||||||
|
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||||
|
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||||
|
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||||
|
echo.may add the Sphinx directory to PATH.
|
||||||
|
echo.
|
||||||
|
echo.If you don't have Sphinx installed, grab it from
|
||||||
|
echo.https://www.sphinx-doc.org/
|
||||||
|
exit /b 1
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "" goto help
|
||||||
|
|
||||||
|
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||||
|
goto end
|
||||||
|
|
||||||
|
:help
|
||||||
|
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||||
|
|
||||||
|
:end
|
||||||
|
popd
|
||||||
10
docs/modules.rst
Normal file
10
docs/modules.rst
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
AuroraLang
|
||||||
|
==========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
aurora
|
||||||
|
exceptions
|
||||||
|
internal
|
||||||
|
main
|
||||||
@@ -1,11 +1,10 @@
|
|||||||
|
# d888888
|
||||||
|
# d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
||||||
|
# d88P aaa 888 888 888P d88^^88b 888P 88b
|
||||||
|
# d88P aaa 888 888 888 888 888 888 .d888888
|
||||||
|
# d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
||||||
|
# d88P aaa Y88888 888 Y88P 888 Y888888
|
||||||
|
# -- Copyright © 2023 Zandercraft. All rights reserved. --
|
||||||
"""
|
"""
|
||||||
d888888
|
|
||||||
d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
|
||||||
d88P aaa 888 888 888P d88^^88b 888P 88b
|
|
||||||
d88P aaa 888 888 888 888 888 888 .d888888
|
|
||||||
d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
|
||||||
d88P aaa Y88888 888 Y88P 888 Y888888
|
|
||||||
-- Copyright © 2023 Zandercraft. All rights reserved. --
|
|
||||||
|
|
||||||
Purpose: Basic exception types.
|
Purpose: Basic exception types.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -1,12 +1,11 @@
|
|||||||
|
# d888888
|
||||||
|
# d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
||||||
|
# d88P aaa 888 888 888P d88^^88b 888P 88b
|
||||||
|
# d88P aaa 888 888 888 888 888 888 .d888888
|
||||||
|
# d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
||||||
|
# d88P aaa Y88888 888 Y88P 888 Y888888
|
||||||
|
# -- Copyright © 2023 Zandercraft. All rights reserved. --
|
||||||
"""
|
"""
|
||||||
d888888
|
|
||||||
d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
|
||||||
d88P aaa 888 888 888P d88^^88b 888P 88b
|
|
||||||
d88P aaa 888 888 888 888 888 888 .d888888
|
|
||||||
d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
|
||||||
d88P aaa Y88888 888 Y88P 888 Y888888
|
|
||||||
-- Copyright © 2023 Zandercraft. All rights reserved. --
|
|
||||||
|
|
||||||
Purpose: Internal utilities and functions.
|
Purpose: Internal utilities and functions.
|
||||||
NOTE: Meant to be used internally in Aurora. It is not meant for external use.
|
NOTE: Meant to be used internally in Aurora. It is not meant for external use.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -1,12 +1,11 @@
|
|||||||
|
# d888888
|
||||||
|
# d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
||||||
|
# d88P aaa 888 888 888P d88^^88b 888P 88b
|
||||||
|
# d88P aaa 888 888 888 888 888 888 .d888888
|
||||||
|
# d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
||||||
|
# d88P aaa Y88888 888 Y88P 888 Y888888
|
||||||
|
# -- Copyright © 2023 Zandercraft. All rights reserved. --
|
||||||
"""
|
"""
|
||||||
d888888
|
|
||||||
d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
|
||||||
d88P aaa 888 888 888P d88^^88b 888P 88b
|
|
||||||
d88P aaa 888 888 888 888 888 888 .d888888
|
|
||||||
d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
|
||||||
d88P aaa Y88888 888 Y88P 888 Y888888
|
|
||||||
-- Copyright © 2023 Zandercraft. All rights reserved. --
|
|
||||||
|
|
||||||
Purpose: Contains utility functions to enhance terminal functionality.
|
Purpose: Contains utility functions to enhance terminal functionality.
|
||||||
NOTE: Meant to be used internally in Aurora. It is not meant for external use.
|
NOTE: Meant to be used internally in Aurora. It is not meant for external use.
|
||||||
"""
|
"""
|
||||||
|
|||||||
15
main.py
15
main.py
@@ -1,12 +1,11 @@
|
|||||||
|
# d888888
|
||||||
|
# d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
||||||
|
# d88P aaa 888 888 888P d88^^88b 888P 88b
|
||||||
|
# d88P aaa 888 888 888 888 888 888 .d888888
|
||||||
|
# d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
||||||
|
# d88P aaa Y88888 888 Y88P 888 Y888888
|
||||||
|
# -- Copyright © 2023 Zandercraft. All rights reserved. --
|
||||||
"""
|
"""
|
||||||
d888888
|
|
||||||
d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
|
||||||
d88P aaa 888 888 888P d88^^88b 888P 88b
|
|
||||||
d88P aaa 888 888 888 888 888 888 .d888888
|
|
||||||
d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
|
||||||
d88P aaa Y88888 888 Y88P 888 Y888888
|
|
||||||
-- Copyright © 2023 Zandercraft. All rights reserved. --
|
|
||||||
|
|
||||||
Purpose: Command-line interface for the aurora language.
|
Purpose: Command-line interface for the aurora language.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|||||||
18
requirements.txt
Normal file
18
requirements.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# d888888
|
||||||
|
# d88P aaa 888 888 888d88 .d88b. 888d88 8888b.
|
||||||
|
# d88P aaa 888 888 888P d88^^88b 888P 88b
|
||||||
|
# d88P aaa 888 888 888 888 888 888 .d888888
|
||||||
|
# d8888888888 Y88b 888 888 Y88..88P 888 888 888
|
||||||
|
# d88P aaa Y88888 888 Y88P 888 Y888888
|
||||||
|
# -- Copyright © 2023 Zandercraft. All rights reserved. --
|
||||||
|
#
|
||||||
|
# Purpose: Project dependencies
|
||||||
|
# Note: Aurora strives to remain simple and portable by using
|
||||||
|
# only pure Python constructs. All dependencies here are
|
||||||
|
# OPTIONAL and are only used for the purpose of aiding
|
||||||
|
# development. These are only needed if you are changing
|
||||||
|
# or contributing to Aurora.
|
||||||
|
|
||||||
|
# Documentation
|
||||||
|
sphinx ~= 6.1.3
|
||||||
|
sphinx_rtd_theme ~= 1.2.0
|
||||||
Reference in New Issue
Block a user