Skip to content

Commit d88ce71

Browse files
committed
Refine docs homepage and examples pages
1 parent d4ee934 commit d88ce71

7 files changed

Lines changed: 379 additions & 238 deletions

File tree

HISTORY.rst

Lines changed: 50 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,78 @@
11
History
22
-------
3-
0.3.4 (2024-10-01)
43

5-
From issues #16 - Including dependencies in Pypi package
6-
- Have updated setup.py file and dependencies are included in Pypi directly.
4+
Unreleased
5+
~~~~~~~~~~
76

8-
Thanks to @manulera for raising this issue.
7+
- Repaired and modernized the documentation with a Sphinx + PyData Sphinx Theme setup.
8+
- Added a cleaner front page, quickstart example, workflow gallery refresh, and improved Colab notebook links.
99

10-
0.3.3 (2023-11-08)
10+
1.0.5 (2026-03-15)
11+
~~~~~~~~~~~~~~~~~~
1112

12-
- Updated readme file with extra examples
13+
- Added the Aspergillus CRISPR workflow notebook.
14+
- Introduced the ``teemi.legacy.build`` namespace to preserve older build helpers while simplifying the main build modules.
15+
- Added tests around CRISPR guide logic and sequence fetching.
1316

14-
- Fixed setup.py file for installation of development packages like: pip install teemi[dev]
17+
1.0.4 (2026-03-14)
18+
~~~~~~~~~~~~~~~~~~
1519

20+
- Updated the PyPI publishing workflow.
1621

17-
0.3.2 (2023-01-08)
22+
1.0.3 (2026-03-14)
23+
~~~~~~~~~~~~~~~~~~
1824

19-
This release features a re-factored DesignAssembly class with:
25+
- Added roadmap and release documentation to support project planning and maintenance.
2026

21-
- Simplified methods i.e. redundant methods have been removed.
27+
1.0.2 (2025-11-14)
28+
~~~~~~~~~~~~~~~~~~
2229

23-
- The ability to add more than one pad, which can be used to make constructs with overlapping ends for for plasmid cloning.
24-
30+
- Fixed a small packaging/versioning issue in the release process.
2531

26-
0.3.1 (2023-31-07)
27-
- This release failed due to a bug in the readme file.
32+
1.0.1 (2025-02-15)
33+
~~~~~~~~~~~~~~~~~~
2834

35+
- Fixed a PyPI packaging syntax issue in the README metadata used during release.
2936

30-
0.3.0 (2023-22-06)
37+
1.0.0 (2025-02-15)
3138
~~~~~~~~~~~~~~~~~~
3239

33-
* New submodules: gibson_cloning
40+
- Updated CI/test configuration around supported Python versions for the 1.0 release line.
3441

35-
This module is used to perform simple Gibson cloning workflows.
36-
While the addition of the "gibson_cloning" submodule is an exciting development, this module is still a work in progress.
37-
Next, a golden gate module. Keep posted on the progress.
42+
0.5.1 (2024-10-01)
43+
~~~~~~~~~~~~~~~~~~
3844

45+
- Updated packaging so project dependencies are included directly in the PyPI package.
3946

40-
0.2.0 (2023-31-05)
47+
0.5.0 (2023-11-08)
4148
~~~~~~~~~~~~~~~~~~
4249

43-
* New submodules: CRISPRsequencecutter, sequence_finder.
50+
- Expanded the README with more examples.
51+
- Fixed installation of development extras such as ``pip install teemi[dev]``.
52+
53+
0.4.0 (2023-01-08)
54+
~~~~~~~~~~~~~~~~~~
4455

45-
CRISPRSequenceCutter is a dataclass that is used to cut DNA through CRISPR-cas9 double-stranded break.
46-
SequenceFinder is a dataclass that finds upstream and downstream sequences from a sequence input, annotates them and saves them.
56+
- Refactored the ``DesignAssembly`` class.
57+
- Simplified redundant methods.
58+
- Added support for multiple pads when constructing assemblies.
4759

48-
0.1.0 (2023-01-02)
60+
0.3.1 (2023-07-31)
4961
~~~~~~~~~~~~~~~~~~
5062

51-
* First release on PyPI.
63+
- Release attempt affected by a README bug.
5264

65+
0.3.0 (2023-06-22)
66+
~~~~~~~~~~~~~~~~~~
67+
68+
- Added the ``gibson_cloning`` submodule for simple Gibson cloning workflows.
69+
70+
0.2.0 (2023-05-31)
71+
~~~~~~~~~~~~~~~~~~
72+
73+
- Added the ``CRISPRsequencecutter`` and ``sequence_finder`` submodules.
74+
75+
0.1.0 (2023-02-01)
76+
~~~~~~~~~~~~~~~~~~
5377

78+
- First release on PyPI.

docs/_static/custom.css

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,20 @@
55
--teemi-border: #cbd5e1;
66
}
77

8-
.bd-header-announcement {
9-
background: linear-gradient(90deg, var(--teemi-accent-dark), var(--teemi-accent));
10-
color: #f8fafc;
11-
}
12-
138
.bd-main .hero {
149
margin: 0 0 2rem;
15-
padding: 2rem;
16-
border: 1px solid var(--teemi-border);
17-
border-radius: 20px;
18-
background:
19-
radial-gradient(circle at top right, rgba(15, 118, 110, 0.18), transparent 32%),
20-
linear-gradient(135deg, #f8fffe, var(--teemi-soft));
10+
padding: 0.5rem 0 1rem;
11+
border: 0;
12+
border-radius: 0;
13+
background: transparent;
2114
}
2215

2316
.bd-main .hero h1 {
2417
margin: 0.25rem 0 1rem;
2518
font-size: clamp(2rem, 4vw, 3.2rem);
2619
line-height: 1.05;
2720
max-width: 12ch;
21+
color: #e2e8f0;
2822
}
2923

3024
.bd-main .hero-kicker {
@@ -39,6 +33,15 @@
3933
.bd-main .hero-lead {
4034
max-width: 58rem;
4135
font-size: 1.08rem;
36+
color: #cbd5e1;
37+
}
38+
39+
.bd-main .fair-callout {
40+
max-width: 58rem;
41+
margin: 0.25rem 0 2rem;
42+
font-size: 1.34rem;
43+
line-height: 1.5;
44+
color: #e2e8f0;
4245
}
4346

4447
.bd-main .link-grid {

0 commit comments

Comments
 (0)