Skip to content

Commit 14fa65b

Browse files
ghandicghandic
authored
Bumping and freshening up the doc generation ready for better content (ghandic#98)
* Bumping and freshening up the doc generation ready for better content
1 parent 0598f0e commit 14fa65b

37 files changed

+296
-366
lines changed

‎.github/workflows/latest-changes.yaml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Latest Changes
2+
3+
on:
4+
pull_request_target:
5+
branches:
6+
- master
7+
types:
8+
- closed
9+
workflow_dispatch:
10+
inputs:
11+
number:
12+
description: PR number
13+
required: true
14+
debug_enabled:
15+
description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
16+
required: false
17+
default: 'false'
18+
19+
jobs:
20+
latest-changes:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Dump GitHub context
24+
env:
25+
GITHUB_CONTEXT: ${{ toJson(github) }}
26+
run: echo "$GITHUB_CONTEXT"
27+
- uses: actions/checkout@v4
28+
with:
29+
# To allow latest-changes to commit to the main branch
30+
token: ${{ secrets.FASTAPI_LATEST_CHANGES }}
31+
# Allow debugging with tmate
32+
- name: Setup tmate session
33+
uses: mxschmitt/action-tmate@v3
34+
if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
35+
with:
36+
limit-access-to-actor: true
37+
- uses: docker://tiangolo/latest-changes:0.3.0
38+
# - uses: tiangolo/latest-changes@main
39+
with:
40+
token: ${{ secrets.GITHUB_TOKEN }}
41+
latest_changes_file: docs/release-notes.md
42+
latest_changes_header: '## Latest Changes'
43+
end_regex: '^## '
44+
debug_logs: true
45+
label_header_prefix: '### '

‎.github/workflows/mkdoc-gh-pages.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ jobs:
99
runs-on: ubuntu-latest
1010
steps:
1111
- uses: actions/checkout@v4
12-
- name: Set up Python 3.8
12+
- name: Set up Python 3.11
1313
uses: actions/setup-python@v5
1414
with:
15-
python-version: 3.8
15+
python-version: 3.11
1616
- name: Install dependencies
1717
run: |
1818
python -m pip install --upgrade pip

‎docker-compose.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ services:
77
ports:
88
- "8000:8000"
99
volumes:
10-
- .:/docs
10+
- ./docs:/docs
11+
- ./mkdocs.yml:/mkdocs.yml
1112
entrypoint: mkdocs serve --dev-addr 0.0.0.0:8000

‎docs/Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
FROM squidfunk/mkdocs-material
1+
FROM python:3.11
22
ADD requirements.txt .
33
RUN pip install -r requirements.txt

‎docs/about/about.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
About JSF, its design, inspiration and more. 🤓

docs/alternatives.md renamed to docs/about/alternatives.md

File renamed without changes.

docs/code-of-conduct.md renamed to docs/about/code-of-conduct.md

File renamed without changes.

‎docs/assets/css/styles.css‎

Lines changed: 0 additions & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -45,136 +45,6 @@ td p {
4545
fill: var(--md-primary-bg-color);
4646
}
4747

48-
[data-md-color-scheme="capgemini"] {
49-
--md-primary-fg-color: rgba(0, 112, 173);
50-
--md-primary-fg-color--light: rgba(18, 171, 219);
51-
--md-primary-fg-color--dark: rgba(43, 10, 61);
52-
53-
/* // Code color shades */
54-
--md-code-fg-color: hsla(200, 18%, 26%, 1);
55-
--md-code-bg-color: hsla(0, 0%, 96%, 1);
56-
57-
/* // Code highlighting color shades */
58-
--md-code-hl-color: hsla(#{hex2hsl($clr-yellow-a200)}, 0.5);
59-
--md-code-hl-number-color: hsla(0, 67%, 50%, 1);
60-
--md-code-hl-special-color: hsla(340, 83%, 47%, 1);
61-
--md-code-hl-function-color: hsla(291, 45%, 50%, 1);
62-
--md-code-hl-constant-color: hsla(250, 63%, 60%, 1);
63-
--md-code-hl-keyword-color: hsla(219, 54%, 51%, 1);
64-
--md-code-hl-string-color: hsla(150, 63%, 30%, 1);
65-
--md-code-hl-name-color: var(--md-code-fg-color);
66-
--md-code-hl-operator-color: var(--md-default-fg-color--light);
67-
--md-code-hl-punctuation-color: var(--md-default-fg-color--light);
68-
--md-code-hl-comment-color: var(--md-default-fg-color--light);
69-
--md-code-hl-generic-color: var(--md-default-fg-color--light);
70-
--md-code-hl-variable-color: var(--md-default-fg-color--light);
71-
72-
/* // Typeset color shades */
73-
--md-typeset-color: var(--md-default-fg-color);
74-
--md-typeset-a-color: var(--md-primary-fg-color);
75-
76-
/* // Typeset `mark` color shades */
77-
--md-typeset-mark-color: hsla(#{hex2hsl($clr-yellow-a200)}, 0.5);
78-
79-
/* // Typeset `del` and `ins` color shades */
80-
--md-typeset-del-color: hsla(6, 90%, 60%, 0.15);
81-
--md-typeset-ins-color: hsla(150, 90%, 44%, 0.15);
82-
83-
/* // Typeset `kbd` color shades */
84-
--md-typeset-kbd-color: hsla(0, 0%, 98%, 1);
85-
--md-typeset-kbd-accent-color: hsla(0, 100%, 100%, 1);
86-
--md-typeset-kbd-border-color: hsla(0, 0%, 72%, 1);
87-
88-
/* // Admonition color shades */
89-
--md-admonition-fg-color: var(--md-default-fg-color);
90-
--md-admonition-bg-color: var(--md-default-bg-color);
91-
92-
/* // Footer color shades */
93-
--md-footer-fg-color: hsla(0, 0%, 100%, 1);
94-
--md-footer-fg-color--light: hsla(0, 0%, 100%, 0.7);
95-
--md-footer-fg-color--lighter: hsla(0, 0%, 100%, 0.3);
96-
--md-footer-bg-color: hsla(0, 0%, 0%, 0.87);
97-
--md-footer-bg-color--dark: hsla(0, 0%, 0%, 0.32);
98-
}
99-
100-
/* ////
101-
/// Copyright (c) 2016-2020 Martin Donath <[email protected]>
102-
///
103-
/// Permission is hereby granted, free of charge, to any person obtaining a
104-
/// copy of this software and associated documentation files (the "Software"),
105-
/// to deal in the Software without restriction, including without limitation
106-
/// the rights to use, copy, modify, merge, publish, distribute, sublicense,
107-
/// and/or sell copies of the Software, and to permit persons to whom the
108-
/// Software is furnished to do so, subject to the following conditions:
109-
///
110-
/// The above copyright notice and this permission notice shall be included in
111-
/// all copies or substantial portions of the Software.
112-
///
113-
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
114-
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
115-
/// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
116-
/// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
117-
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
118-
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
119-
/// DEALINGS
120-
////
121-
122-
// ----------------------------------------------------------------------------
123-
// Rules
124-
// ----------------------------------------------------------------------------
125-
126-
// Slate theme, i.e. dark mode */
127-
[data-md-color-scheme="slate"] {
128-
/* // Slate's hue in the range [0,360] - change this variable to alter the tone
129-
// of the theme, e.g. to make it more redish or greenish. This is a slate-
130-
// specific variable, but the same approach may be adapted to custom themes. */
131-
--md-hue: 232;
132-
--md-primary-fg-color: rgba(0, 112, 173);
133-
--md-primary-fg-color--light: rgba(18, 171, 219);
134-
--md-primary-fg-color--dark: rgba(43, 10, 61);
135-
136-
/* // Default color shades */
137-
--md-default-fg-color: hsla(var(--md-hue), 75%, 95%, 1);
138-
--md-default-fg-color--light: hsla(var(--md-hue), 75%, 90%, 0.62);
139-
--md-default-fg-color--lighter: hsla(var(--md-hue), 75%, 90%, 0.32);
140-
--md-default-fg-color--lightest: hsla(var(--md-hue), 75%, 90%, 0.12);
141-
--md-default-bg-color: hsla(var(--md-hue), 15%, 21%, 1);
142-
--md-default-bg-color--light: hsla(var(--md-hue), 15%, 21%, 0.54);
143-
--md-default-bg-color--lighter: hsla(var(--md-hue), 15%, 21%, 0.26);
144-
--md-default-bg-color--lightest: hsla(var(--md-hue), 15%, 21%, 0.07);
145-
146-
/* // Code color shades */
147-
--md-code-fg-color: hsla(var(--md-hue), 18%, 86%, 1);
148-
--md-code-bg-color: hsla(var(--md-hue), 15%, 15%, 1);
149-
150-
/* // Code highlighting color shades */
151-
--md-code-hl-color: hsla(#{hex2hsl($clr-blue-a200)}, 0.15);
152-
--md-code-hl-number-color: hsla(6, 74%, 63%, 1);
153-
--md-code-hl-special-color: hsla(340, 83%, 66%, 1);
154-
--md-code-hl-function-color: hsla(291, 57%, 65%, 1);
155-
--md-code-hl-constant-color: hsla(250, 62%, 70%, 1);
156-
--md-code-hl-keyword-color: hsla(219, 66%, 64%, 1);
157-
--md-code-hl-string-color: hsla(150, 58%, 44%, 1);
158-
159-
/* // Typeset color shades */
160-
--md-typeset-a-color: var(--md-primary-fg-color--light);
161-
162-
/* // Typeset `mark` color shades */
163-
--md-typeset-mark-color: hsla(#{hex2hsl($clr-blue-a200)}, 0.3);
164-
165-
/* // Typeset `kbd` color shades */
166-
--md-typeset-kbd-color: hsla(var(--md-hue), 15%, 94%, 0.12);
167-
--md-typeset-kbd-accent-color: hsla(var(--md-hue), 15%, 94%, 0.2);
168-
--md-typeset-kbd-border-color: hsla(var(--md-hue), 15%, 14%, 1);
169-
170-
/* // Admonition color shades */
171-
--md-admonition-bg-color: hsla(var(--md-hue), 0%, 100%, 0.025);
172-
173-
/* // Footer color shades */
174-
--md-footer-bg-color: hsla(var(--md-hue), 15%, 12%, 0.87);
175-
--md-footer-bg-color--dark: hsla(var(--md-hue), 15%, 10%, 1);
176-
}
177-
17848
.md-header-nav__button.md-logo img,
17949
.md-header-nav__button.md-logo svg {
18050
width: unset;

‎docs/assets/js/theme.js‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎docs/features.md‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
1-
## Coming soon ...
1+
---
2+
hide:
3+
- navigation
4+
---
5+
6+
# jsf Features
7+
8+
**jsf** gives you the following:
9+
10+
## Based on open standards
11+
12+
- Provides out of the box data generation from any [JSON schema](https://json-schema.org/) 📦
13+
- In memory conversion from [JSON Schema](https://json-schema.org/) to [Pydantic](https://docs.pydantic.dev/latest/) Models with generated examples 🤯
14+
- Inbuilt validation of fake JSON produced against the [JSON schema](https://json-schema.org/) ✅
15+
16+
## Ability to extend the standard to maximize realness of the fake data
17+
18+
- Extendable custom data providers using any lambda functions 🔗
19+
- Multi level state for dependant data (eg multiple objects sharing value, such as children with same surname) 🤓
20+
21+
## Plug and play
22+
23+
- Seamless integration with [FastAPI](https://fastapi.tiangolo.com/), check out the [demo code](https://github.com/ghandic/jsf/tree/main/examples/fastapi) 🚀
24+
- Standardize on JSON schema and output to any file format, check out the [demo code](https://github.com/ghandic/jsf/tree/main/examples/flatfile) 📦

0 commit comments

Comments
 (0)