mirror of https://github.com/JoshKarpel/spiel
Drop Python 3.9, remove unused docs and perf tests (#129)
Josh Karpel
2 years ago
committed by
GitHub
parent
af8717880f
commit
6e94c12006
@ -1,13 +0,0 @@
|
||||
version: 2
|
||||
|
||||
sphinx:
|
||||
configuration: docs/conf.py
|
||||
|
||||
build:
|
||||
image: testing
|
||||
|
||||
python:
|
||||
version: 3.9
|
||||
install:
|
||||
- method: pip
|
||||
path: .
|
||||
@ -0,0 +1,7 @@
|
||||
# Changelog
|
||||
|
||||
## 0.3.0
|
||||
|
||||
### Removed
|
||||
|
||||
- [#129](https://github.com/JoshKarpel/spiel/pull/129) Dropped support for Python `<=3.9`.
|
||||
@ -1,20 +0,0 @@
|
||||
# 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)
|
||||
@ -1,33 +0,0 @@
|
||||
import sphinx_rtd_theme
|
||||
|
||||
import spiel
|
||||
|
||||
project = spiel.constants.PACKAGE_NAME.capitalize()
|
||||
copyright = "2021, Josh Karpel"
|
||||
author = "Josh Karpel"
|
||||
release = spiel.constants.__version__
|
||||
|
||||
|
||||
extensions = [
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.napoleon",
|
||||
"sphinx_rtd_theme",
|
||||
]
|
||||
|
||||
templates_path = ["_templates"]
|
||||
html_static_path = ["_static"]
|
||||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
||||
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
# sphinx-autodoc
|
||||
autoclass_content = "both"
|
||||
autodoc_member_order = "bysource"
|
||||
autodoc_default_options = {
|
||||
"members": True,
|
||||
"undoc-members": True,
|
||||
}
|
||||
autodoc_typehints = "signature"
|
||||
|
||||
# sphinx-autodoc-typehints
|
||||
set_type_checking_flag = True
|
||||
@ -1,18 +0,0 @@
|
||||
Spiel
|
||||
=====
|
||||
|
||||
Spiel is a framework for building and presenting richly-styled presentations in your terminal using Python.
|
||||
|
||||
To see what Spiel can do, install it (``pip install spiel``), then run this command to view the demonstration deck:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ spiel demo present
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
self
|
||||
reference
|
||||
@ -1,35 +0,0 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%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.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
||||
@ -1,28 +0,0 @@
|
||||
Reference
|
||||
=========
|
||||
|
||||
.. py:currentmodule:: spiel
|
||||
|
||||
|
||||
Decks and Slides
|
||||
----------------
|
||||
|
||||
.. autoclass:: Deck
|
||||
|
||||
.. autoclass:: Slide
|
||||
|
||||
.. autoclass:: Example
|
||||
|
||||
|
||||
Widgets
|
||||
-------
|
||||
|
||||
.. autoclass:: Image
|
||||
|
||||
.. autoclass:: Plot
|
||||
|
||||
|
||||
Triggers
|
||||
--------
|
||||
|
||||
.. autoclass:: Triggers
|
||||
@ -1,29 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
|
||||
import os
|
||||
|
||||
from rich.console import Console
|
||||
|
||||
from spiel.main import DEMO_SOURCE
|
||||
from spiel.present import render_slide
|
||||
from spiel.state import State
|
||||
|
||||
CYCLES_PER_SLIDE = 10
|
||||
TRIGGERS_PER_SLIDE = 10
|
||||
|
||||
|
||||
def render_demo_repeatedly() -> None:
|
||||
with open(os.devnull, "w") as f:
|
||||
state = State.from_file(DEMO_SOURCE, console=Console(file=f))
|
||||
|
||||
for _ in range(CYCLES_PER_SLIDE):
|
||||
for slide in state.deck:
|
||||
for _ in range(TRIGGERS_PER_SLIDE):
|
||||
rendered = render_slide(state, slide)
|
||||
state.console.print(rendered)
|
||||
state.trigger()
|
||||
state.reset_trigger()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
render_demo_repeatedly()
|
||||
@ -1,25 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
|
||||
import os
|
||||
|
||||
from rich.console import Console
|
||||
|
||||
from spiel.main import DEMO_SOURCE
|
||||
from spiel.present import render_slide
|
||||
from spiel.state import State
|
||||
|
||||
CYCLES_PER_SLIDE = 100
|
||||
|
||||
|
||||
def render_image_repeatedly() -> None:
|
||||
with open(os.devnull, "w") as f:
|
||||
state = State.from_file(DEMO_SOURCE, console=Console(file=f))
|
||||
|
||||
for _ in range(CYCLES_PER_SLIDE):
|
||||
slide = [slide for slide in state.deck.slides if "Image" in slide.title][0]
|
||||
rendered = render_slide(state, slide)
|
||||
state.console.print(rendered)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
render_image_repeatedly()
|
||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue