Skip to content
This repository was archived by the owner on Dec 23, 2025. It is now read-only.

Commit bc11725

Browse files
JoshKarpelJoshKarpel
committed
wip
1 parent 1a1b62f commit bc11725

34 files changed

+815
-281
lines changed

‎.github/workflows/publish-docs.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: publish-docs_old
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
publish-docs:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Check out repository
13+
uses: actions/checkout@v3.3.0
14+
- name: Set up Python 3.x
15+
uses: actions/setup-python@v4.5.0
16+
with:
17+
python-version: "3.x"
18+
- name: Install Poetry
19+
uses: snok/install-poetry@v1.3.3
20+
- name: Install Package
21+
run: poetry install
22+
- name: Build and deploy docs_old
23+
run: poetry run mkdocs gh-deploy --clean --strict --verbose --force

‎.github/workflows/quality-check.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ jobs:
4141
# run: poetry run mypy
4242
- name: Test code
4343
run: poetry run pytest -v --cov --cov-report=xml --durations=20
44-
# - name: Test docs
45-
# run: poetry run mkdocs build --clean --strict --verbose
44+
- name: Test docs_old
45+
run: poetry run mkdocs build --clean --strict --verbose
4646
- name: Upload coverage
4747
uses: codecov/codecov-action@v3.1.1
4848
with:

‎.gitignore‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,6 @@ instance/
6363
# Scrapy stuff:
6464
.scrapy
6565

66-
# Sphinx documentation
67-
#docs/_build/
68-
6966
# PyBuilder
7067
target/
7168

‎.readthedocs.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build:
44
image: latest
55

66
sphinx:
7-
configuration: docs/source/conf.py
7+
configuration: docs_old/source/conf.py
88

99
formats: all
1010

@@ -14,4 +14,4 @@ python:
1414
- method: pip
1515
path: .
1616
extra_requirements:
17-
- docs
17+
- docs_old

‎docs/api.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# API Reference
2+
3+
::: idesolver.IDESolver
4+
5+
::: idesolver.global_error
6+
7+
::: idesolver.complex_quad

‎docs/assets/mathjax.js‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
window.MathJax = {
2+
tex: {
3+
inlineMath: [["\\(", "\\)"]],
4+
displayMath: [["\\[", "\\]"]],
5+
processEscapes: true,
6+
processEnvironments: true
7+
},
8+
options: {
9+
ignoreHtmlClass: ".*|",
10+
processHtmlClass: "arithmatex"
11+
}
12+
};
13+
14+
document$.subscribe(() => {
15+
MathJax.typesetPromise()
16+
})

‎docs/assets/style.css‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
:root {
2+
--class-color: #00b8d4;
3+
--class-header-color: #00b8d41a;
4+
--function-color: #448aff;
5+
--function-header-color: #448aff1a;
6+
}
7+
8+
article > .doc {
9+
border-style: solid;
10+
border-width: 0.05rem;
11+
border-radius: 0.2rem;
12+
padding: 0.6rem 0.6rem;
13+
box-shadow: var(--md-shadow-z1);
14+
}
15+
16+
article > .doc + .doc {
17+
margin-top: 1rem;
18+
}
19+
20+
h3.doc {
21+
margin: -0.6rem;
22+
padding: 0.6rem;
23+
}
24+
25+
article > .doc.doc-class {
26+
border-color: var(--class-color);
27+
}
28+
29+
.doc-class > h3.doc {
30+
background-color: var(--class-header-color);
31+
}
32+
33+
article > .doc.doc-function {
34+
border-color: var(--function-color);
35+
}
36+
37+
.doc-function > h3.doc {
38+
background-color: var(--function-header-color);
39+
}
40+
41+
/* Indentation. */
42+
div.doc-contents:not(.first) {
43+
padding-left: 25px;
44+
border-left: .05rem solid var(--md-typeset-table-color);
45+
}
46+
47+
/* Mark external links as such. */
48+
a.autorefs-external::after {
49+
/* https://primer.style/octicons/arrow-up-right-24 */
50+
background-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="rgb(0, 0, 0)" d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
51+
content: ' ';
52+
53+
display: inline-block;
54+
position: relative;
55+
top: 0.1em;
56+
margin-left: 0.2em;
57+
margin-right: 0.1em;
58+
59+
height: 1em;
60+
width: 1em;
61+
border-radius: 100%;
62+
background-color: var(--md-typeset-a-color);
63+
}
64+
a.autorefs-external:hover::after {
65+
background-color: var(--md-accent-fg-color);
66+
}

‎docs/changelog.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Changelog
2+
3+
## `1.1.0`
4+
5+
Released `2022-11-19`
6+
7+
### Added
8+
9+
- [#35](https://github.com/JoshKarpel/idesolver/pull/35](https://github.com/nbrucy)) Add support for multidimensional IDEs by [@nbrucy](https://github.com/nbrucy).
10+
11+
## `1.0.5`
12+
13+
### Changed
14+
15+
- Relaxed dependency version restrictions in advance of changes to `pip`.
16+
There shouldn't be any impact on users.
17+
18+
## `1.0.4`
19+
20+
### Changed
21+
22+
- Revision of packaging and CI flow. There shouldn't be any impact on users.
23+
24+
## `1.0.3`
25+
26+
### Changed
27+
28+
- Revision of package structure and CI flow. There shouldn't be any impact on users.
29+
30+
## `1.0.2`
31+
32+
### Changed
33+
34+
- IDESolver now explicitly requires Python 3.6+ on install. Dependencies on `numpy` and `scipy` are given as lower bounds.
35+
36+
## `1.0.1`
37+
38+
### Changed
39+
40+
- Changed the name of `IDESolver.f` to `IDESolver.f`, as intended.
41+
- The default global error function is now injected instead of hard-coded.

‎docs/contributing.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing Guide
2+
3+
!!! info "IDESolver is open to contributions!"
4+
5+
- [Report bugs and request features](https://github.com/JoshKarpel/idesolver/issues)
6+
- [General discussion](https://github.com/JoshKarpel/idesolver/discussions)
7+
- [Pull requests](https://github.com/JoshKarpel/idesolver/pulls)
8+
9+
## Development Environment
10+
11+
Spiel uses:
12+
13+
- [`poetry`](https://python-poetry.org) to manage development dependencies.
14+
- [`pre-commit`](https://pre-commit.com) to run various linters and formatters.
15+
- [`pytest`](https://docs.pytest.org) for testing and [`mypy`](https://mypy-lang.org) for static type-checking.
16+
- [`mkdocs`](https://www.mkdocs.org) with the [Material theme](https://squidfunk.github.io/mkdocs-material) for documentation.
17+
18+
### Initial Setup
19+
20+
To set up a local development environment after cloning the repository:
21+
22+
1. [Install `poetry`](https://python-poetry.org/docs/#installation).
23+
2. Run `poetry shell` to create a virtual environment for `idesolver` and spawn a new shell session with that virtual environment activated.
24+
In the future you'll run `poetry shell` again to activate the virtual environment.
25+
3. Run `poetry install` to install IDESolver's dependencies.
26+
4. Run `pre-commit install` to configure `pre-commit`'s integration with `git`.
27+
Do not commit without `pre-commit` installed!
28+
29+
### Running Tests and Type-Checking
30+
31+
Run `pytest` to run tests.
32+
33+
Run `mypy` to check types.
34+
35+
### Building the Docs Locally
36+
37+
To build the docs and start a local web server to view the results of your edits with live reloading, run
38+
```bash
39+
mkdocs serve
40+
```
41+
from the repository root.

‎docs/examples/__init__.py‎

Whitespace-only changes.

0 commit comments

Comments
 (0)