Skip to content

Commit ff846b4

Browse files
committed
feat: move docs/_posts pages into content directory
- and remove last vestiges of Jekyll
1 parent 0a4f3b5 commit ff846b4

File tree

1,790 files changed

+30
-984710
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,790 files changed

+30
-984710
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ tags
2020
!.gitignore
2121
!.npmignore
2222

23+
docs
2324
tmp

Makefile

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,53 @@
11
# Manage plotly.js documentation.
22

33
RUN = uv run
4-
DOC_SRC=docs/_posts
4+
HANDWRITTEN=content
55
SCHEMA_SRC=test/plot-schema.json
6+
TMP=tmp
7+
EXAMPLES_DIR=${TMP}/javascript
8+
EXAMPLES_FILE=${EXAMPLES_DIR}/axes/index.html
9+
REFERENCE_DIR=${TMP}/reference
10+
REFERENCE_FILE=${REFERENCE_DIR}/bar/index.html
611

712
## commands: show available commands
813
commands:
914
@grep -h -E '^##' ${MAKEFILE_LIST} | sed -e 's/## //g' | column -t -s ':'
1015

11-
## doc: rebuild documentation
12-
.PHONY: doc
13-
doc:
14-
make examples
15-
make reference
16-
make build
16+
## docs: rebuild documentation
17+
.PHONY: docs
18+
docs: ${EXAMPLES_FILE} ${REFERENCE_FILE}
19+
${RUN} mkdocs build
1720

1821
## examples: build example documentation in ./tmp
19-
examples:
20-
@mkdir -p tmp
21-
${RUN} bin/example_pages.py --indir ${DOC_SRC}/plotly_js --outdir tmp/javascript --jsversion 3.2.1
22-
23-
## format: reformat Python code
24-
format:
25-
@ruff format bin
22+
examples: ${EXAMPLES_FILE}
2623

27-
## lint: check code and project
28-
lint:
29-
@ruff check bin
24+
${EXAMPLES_FILE}:
25+
@mkdir -p ${TMP}
26+
${RUN} bin/example_pages.py --indir ${HANDWRITTEN}/plotly_js --outdir ${EXAMPLES_DIR} --jsversion 3.2.1
3027

3128
## reference: build reference documentation in ./tmp
32-
reference:
33-
@mkdir -p tmp
34-
${RUN} bin/reference_pages.py --schema ${SCHEMA_SRC} --outdir tmp/reference ${DOC_SRC}/reference_pages/javascript/*.html
29+
reference: ${REFERENCE_FILE}
30+
31+
${REFERENCE_FILE}:
32+
@mkdir -p ${TMP}
33+
${RUN} bin/reference_pages.py --schema ${SCHEMA_SRC} --outdir ${TMP}/reference ${HANDWRITTEN}/reference_pages/javascript/*.html
3534

3635
## serve: display documentation
3736
serve:
3837
${RUN} mkdocs serve
3938

40-
## website: build documentation with mkdocs using already-built examples and reference
41-
website:
42-
${RUN} mkdocs build
43-
4439
## --: --
4540

4641
## clean: clean up repository
4742
clean:
4843
@find . -name '*~' -delete
4944
@find . -name '.DS_Store' -delete
50-
@rm -rf _site
51-
@rm -f ${SCHEMA_DST}
45+
@rm -rf docs ${TMP}
46+
47+
## format: reformat Python code
48+
format:
49+
@ruff format bin
50+
51+
## lint: check code and project
52+
lint:
53+
@ruff check bin
File renamed without changes.

0 commit comments

Comments
 (0)