Skip to content
This repository has been archived by the owner on Jun 7, 2023. It is now read-only.

Commit

Permalink
Add: CodeChat/Runestone docs build.
Browse files Browse the repository at this point in the history
  • Loading branch information
bjones1 committed Jul 30, 2020
1 parent 3dd41d2 commit 13cde7b
Show file tree
Hide file tree
Showing 70 changed files with 1,022 additions and 45 deletions.
3 changes: 3 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# *********
# |docname|
# *********
# These are supported funding model platforms

#github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# *********
# |docname|
# *********
*.py[cod]
*.log
.venv
Expand Down
18 changes: 18 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# ********************************************
# |docname| - Read the Docs configuration file
# ********************************************
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# TODO: need some way to invoke a runestone build. Idea: a mock conf.py that runs the build in a subprocess.
sphinx:
configuration: conf.py

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- method: pip
path: .
3 changes: 3 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# *********
# |docname|
# *********
dist: xenial
language: python
python:
Expand Down
22 changes: 11 additions & 11 deletions ACKNOWLEDGEMENTS.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
Runestone Interactive would never have come to life without many other open source projects and people. This is an attempt to ackowledge those projects and people.
****************
Acknowledgements
****************
Runestone Interactive would never have come to life without many other open source projects and people. This is an attempt to acknowledge those projects and people.


* CodeLens -- Philip Guo and the Python Tutor Project -- pythontutor.come
* ActiveCode -- The Skulpt project -- skulpt.org
* Parson's Problems -- Ville Karavirta and the team at Georgia Tech who has added tons
* showEval -- Al Sweigart
* ActiveCode -- The Skulpt project -- skulpt.org
* Parson's Problems -- Ville Karavirta and the team at Georgia Tech who has added tons
* showEval -- Al Sweigart
* Short Answer -- Cory Bart at Virginia Tech
* the Blockly project @ Google
* The Sphinx and Docutils projects

Luther College
--------------
==============
* Brad Miller
* David Ranum
* Roman Yasinovskyy
Expand All @@ -25,8 +28,7 @@ Luther College
* Tyler Conzett

Georgia Tech
------------

============
* Barbara Ericson
* Mark Guzdial
* Jeff Rick
Expand All @@ -35,13 +37,11 @@ Georgia Tech
* Matt Moldovan

University of Michigan
----------------------

======================
* Paul Resnick
* Jackie Cohen
* Charles Severence

Mississippi State University
----------------------------

============================
* Bryan Jones
3 changes: 3 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# *********
# |docname|
# *********
graft runestone
include requirements.txt
include README.md
Expand Down
23 changes: 23 additions & 0 deletions codechat_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# ************************************************
# |docname| - Configuration for a CodeChat project
# ************************************************
# This file defines the configuration for a CodeChat project. In addition to allowing standard JSON objects, it also allows Python-style comments and any valid Python literal.
#
# The file must contain a single dict, with the following keys:
{
# ``source_path``: optional; defaults to ``.``. A path to the root of the source tree. Relative paths are rooted in the directory containing this file.
"source_path": ".",

# ``output_path``: required. A path to the root of the HTML output produced by this renderer. Relative paths are rooted in the directory containing this file.
"output_path": "build/RunestoneComponents",

# ``args``: required. A list of arguments to invoke the renderer. Each element of the list must be a string. Each string may optionally contain the following replacement values:
#
# - ``{project_path}``: an absolute path to the directory containing this file.
# - ``{source_path}``: the ``source_path`` above, but as an absolute path.
# - ``{output_path}``: the ``output_path`` above, but as an absolute path.
"args": ["runestone", "build"],

# ``html_ext``: optional; defaults to ``.html``. The extension used by this renderer when generating HTML files.
#"html_ext": ".html",
}
Loading

0 comments on commit 13cde7b

Please sign in to comment.