Skip to content

Commit

Permalink
Release v2.0 preparation – Jupyter Book (#12)
Browse files Browse the repository at this point in the history
Fixes #2.

* ch1
* Jinja prep
* Decomposition
* Jupyter Book setup and config
* infobox and exercise directives implementation
* functional swish and infobox directives
* roman- and letter-based enumeration fix
* math fixes
* text fixes
* code cleanup + -start & -end examples clean + swish inheritance fix
* typos
* HTML parentheses fix
* HTML codes fix
* section markings (`+++`)
* figure referencing
* parts references
* appendix references
* chapter references
* section references
* list references fix -- a., b., ... and i., ii., ...
* numbering exercise boxes
* allow exercises to be referenced
* cap the code at 80 lines for improved rendered readability
* linking solutions to exercises
* justify fix
* GitHub deployment preparation
* reading exercises from separate markdown files
* exercise separation
* ASCII cleanup
* math typo
* Simply Logical Jupyter Book extension as a git submodule
  See https://github.com/simply-logical/SL-Sphinx for more details
* Hyper-link marker highlight fix
* Fix footnote numbering
  Workaround for MyST Markdown parser issue #195
* SWISH box ids start with "swish:"
* tabulation
* SWISH query boxes (taken from the first release)
* Content cleanup
* Fix named paragraphs
* pProlog syntax highlighting
* Scrollable SWISH boxes if they exceed 450px (#5)
* Edits Chapters 1-3
* Discard Prolog output from multi-line SWISH queries (closes #5)
* Finished polishing Chs.1-3
* Polished Chs.4-6
* Display SWISH query boxes: copy button + syntax highlight
  1. Display SWISH query box code syntax highlighting
  2. SWISH query box CSS stylesheet correction (_static/lpn.css)
  3. Display SWISH query box copy button -- no need to enable the custom class
     by setting the `copybutton_selector` configuration variable to
     `"div.highlight pre, div.extract.swish pre.swish.query"`
     since the code syntax highlighting embeds an extra `div` element
     and the outer element id is no longer overwritten
     (see <executablebooks/sphinx-copybutton#115>)
* SWISH code box Prolog syntax highlighting (closes #9)
* More SWISH boxes Part II
* Polished Ch.7
* Polished Ch.8
* First Ch.9 edits
* Polished code fragments and exercises
* Improved chapter numbering, hidden examples blocks and glossary skeleton
* Feature integration
* Manual part numbering
* git submodule -> PyPI package
* Up-to-date build and install instructions
* Enables Prolog file-based SWISH code blocks (#10)
* Deployment script fix
* Testing file-based SWISH boxes (sections 9.2 and 9.3)
* sphinx-prolog with correct solution referencing
* Build link check + Figure 4.1.1 (4.2) fix
* Fixed some TODOs
* Depth-2 numbering of figures, exercises and solutions
* Install sphinx-multitoc-numbering from PyPI
* Attribution-NonCommercial-NoDerivs CC BY-NC-ND
* Checked answers to exercises.
* Added preface and first version of glossary.
* jupyter-book==0.10.1
* Fix empty lines
* Added unification TO DO entry
* Fixed broken links
* Update build-and-deploy.yml
* Undo change to build-and-deploy.yml
* Final check of text and programs.
* Graphviz rendering
* Deploy too
* Short glossary intro
* transform.pl
* Update b_1.md
* transform.pl
* Update transform.pl
* complete.pl
* Appendix code boxes again
* Update complete.pl
* Update 9.2.md
* RLGG SWISH box
* Update rlgg.pl
* induce_rlgg SWISH box
* Update 9.2.md
* induce_rlgg SWISH box
* Update glossary.md
* induce_spec SWISH box
* Remove obsolete section92.pl
* induce_spec SWISH box
* Update induce_spec-end.pl
* Update 9.3.md
* Typo
* Generate and test
* Typo
* Relational logic example
* Relational logic example
* Propositional logic example
* Whitespaces
* Release v2.0 prep
  Co-authored-by: Peter Flach <Peter.Flach@bristol.ac.uk>
  • Loading branch information
So-Cool committed Jun 15, 2022
1 parent 45ef078 commit af89082
Show file tree
Hide file tree
Showing 545 changed files with 12,776 additions and 28,471 deletions.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Contact Information
url: https://simply-logical.space/contact-us/
about: Information on how to contact us.
- name: Gitter
url: https://gitter.im/simply-logical/simply-logical/
about: Please ask and answer questions here.
- name: Google Group
url: https://groups.google.com/g/simply-logical/
about: Alternative discussion channel.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/content_issue.md
@@ -0,0 +1,19 @@
---
name: Report an issue with the book content
about: Form for reporting issues with the book content, e.g., typos and formatting problems.
labels: content

---
<!-- CLICK "Preview" FOR INSTRUCTIONS IN A MORE READABLE FORMAT -->

**Please view existing issues to ensure that this report is not a duplicate.**

## Problem Description ##

(Actual and expected content.)

## Context ##

- Platform:
- Web browser:
- URL: https://book.simply-logical.space/ **URL to the content in question**
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/technical_issue.md
@@ -0,0 +1,38 @@
---
name: Report a technical issue with the book
about: Form for reporting issues with Jupyter Book, SWI Prolog, SWISH, etc.
labels: technical

---
<!-- CLICK "Preview" FOR INSTRUCTIONS IN A MORE READABLE FORMAT -->

**Please view existing issues to ensure that this report is not a duplicate.**

## Issue Type ##

- [ ] Building the book (Jupyter Book)
- [ ] Executing Prolog code-boxes (SWI Prolog/SWISH)
- [ ] Other -- please describe below

## Problem Description ##

(Actual and expected behaviour.)

## Steps to Reproduce the Problem ##

1.
1.
1.

## Context ##

- Platform:
- Web browser:
- Python version:
- Jupyter Book version:
- Sphinx version:
- SWI Prolog version:

## Log ##

(If a log is available, please include it.)
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/generic_pr.md
@@ -0,0 +1,28 @@
---
name: Generic Pull Request
about: Template for generic pull requests

---
<!-- CLICK "Preview" FOR INSTRUCTIONS IN A MORE READABLE FORMAT -->

**IMPORTANT: Please do not create a pull request without creating an issue first.**

*Any changes need to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.*

## Description ##

Please explain the improvements that this pull request implements.

## Cross-reference ##

If this pull request relates to any other issue or pull request, please
reference it here using the `#<issue/PR number>` syntax.

To auto-close an issue with this pull request you can either put
`closes #<issue number>` or `fixes #<issue number>` in your comment.

## Proposed Changes ##

- change 1
- change 2
- change 3
30 changes: 30 additions & 0 deletions .github/workflows/build-and-deploy.yml
@@ -0,0 +1,30 @@
name: Build 🔧 the Jupyter Book 📖 and deploy 🚀 it to GitHub Pages
on: push
jobs:
build-n-deploy:
name: Build and deploy
runs-on: ubuntu-18.04
steps:
- name: Checkout code 🛎️
uses: actions/checkout@v2.3.1
with:
persist-credentials: false
- name: Set up Python 3.7 🐍
uses: actions/setup-python@v1
with:
python-version: 3.7
- name: Install dependencies 💾
run: pip install -r requirements.txt
- name: Build the book 🔧📖
run: jb build -nW .
- name: Validate links ☑️🔗
continue-on-error: true
run: jb build -q --builder linkcheck .
- name: Deploy 🚀
if: github.ref == 'refs/heads/master'
uses: JamesIves/github-pages-deploy-action@3.7.1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: _build/html
CLEAN: true
8 changes: 4 additions & 4 deletions .gitignore
@@ -1,6 +1,6 @@
# jekyll
.sass-cache/*
_site/*
# Jupyter Book
_build
src/code/temp

# Mac OS
*.DS_Store
.DS_Store
Empty file added .nojekyll
Empty file.
14 changes: 14 additions & 0 deletions CITATION.cff
@@ -0,0 +1,14 @@
cff-version: 1.2.0
message: "If you use this book, please cite it as below."
authors:
- family-names: "Flach"
given-names: "Peter"
orcid: "https://orcid.org/0000-0001-6857-5810"
- family-names: "Sokol"
given-names: "Kacper"
orcid: "https://orcid.org/0000-0002-9869-5896"
title: "Simply Logical: Intelligent Reasoning by Example (Online Edition)"
version: v2.0
doi: 10.5281/zenodo.1156977
date-released: 2022-07-01
url: "https://book.simply-logical.space/"

0 comments on commit af89082

Please sign in to comment.