Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Generate manual from markdown using mkdocs #3849

Merged
merged 153 commits into from
Nov 14, 2024
Merged
Changes from 1 commit
Commits
Show all changes
153 commits
Select commit Hold shift + click to select a range
a01ab38
very first draft
landam Jun 16, 2024
307432f
re-enable html builds
landam Jun 16, 2024
5aa3564
rename "md" dir to "markdown"
landam Jun 16, 2024
d33bcb9
add converted md file from html using pandoc
landam Jun 16, 2024
e2fd51c
fix various compilation issues
landam Jun 16, 2024
78cbd32
run mkdocs
landam Jun 16, 2024
40b6de9
fix md newline
landam Jun 16, 2024
6d49dae
short commit hash
landam Jun 16, 2024
f0c5311
--md-description: skip main header
landam Jun 16, 2024
f725352
avoid duplicated header for now
landam Jun 16, 2024
bbbeee2
move mkdocs from doc/ to man/
landam Jun 16, 2024
7b7c244
build index file
landam Jun 16, 2024
134ff95
mkdocs: disable directory_urls
landam Jun 17, 2024
3343ae3
lib/init: process md files
landam Jun 17, 2024
f5c4e8b
typo
landam Jun 17, 2024
1f38a1e
implement topic index
landam Jun 17, 2024
93dfcad
implement keyword index
landam Jun 17, 2024
5f3ce2b
enable html keywords index
landam Jun 17, 2024
cd58012
fix grass_logo
landam Jun 17, 2024
f132228
Update man/build_keywords.py
landam Jun 18, 2024
139c5fa
Update man/build_keywords.py
landam Jun 18, 2024
ee88da9
Update man/build_keywords.py
landam Jun 18, 2024
e11b985
Update man/build_keywords.py
landam Jun 18, 2024
71d8df2
Update man/build_keywords.py
landam Jun 18, 2024
6d816e5
Update man/build_keywords.py
landam Jun 18, 2024
58ce945
Update man/build_keywords.py
landam Jun 18, 2024
a72d2ea
Update man/build_keywords.py
landam Jun 18, 2024
adf5af6
change style to material
landam Jun 18, 2024
1b4a3fa
Merge branch 'main' into markdown_docs
landam Jun 18, 2024
13a51fb
implement full_index
landam Jun 18, 2024
0e8e272
logo tuning
landam Jun 18, 2024
97e78ff
fix html keywords
landam Jun 18, 2024
a7c1d33
module md header changed
landam Jun 18, 2024
542ead1
include images
landam Jun 18, 2024
d8ff3de
mkdocs cosmetics
landam Jun 18, 2024
2e34f65
Update man/build_full_index.py
landam Jun 26, 2024
4ecb894
Update man/build_full_index.py
landam Jun 26, 2024
146bb42
Update man/build_full_index.py
landam Jun 26, 2024
2671a0e
Update man/build_full_index.py
landam Jun 26, 2024
2a9a0e5
Update man/build_graphical_index.py
landam Jun 26, 2024
5adea99
Update man/build_graphical_index.py
landam Jun 26, 2024
3b1c8cd
Merge branch 'main' into markdown_docs
landam Jun 26, 2024
cff3253
Update man/build_keywords.py
landam Jun 26, 2024
60fa3b1
Update man/build_graphical_index.py
landam Jun 26, 2024
580fcef
Update man/build_full_index.py
landam Jun 26, 2024
1c9556b
Merge branch 'main' into markdown_docs
landam Aug 8, 2024
08a966c
merge 28bbce8dd772f48d38ef02743ba239207c950c57 + flake8
landam Aug 8, 2024
eef0b70
code block fix in md files
landam Aug 8, 2024
119a0bc
md requiremensts: add mkdocs-material
landam Aug 9, 2024
6c42777
fix compilation issue in gui/scripts
landam Aug 19, 2024
5ab2d36
Update man/build_md.py
landam Aug 19, 2024
d48461b
Update man/build_topics.py
landam Aug 19, 2024
2d78ccf
Update utils/mkmarkdown.py
landam Aug 19, 2024
52d356d
Update utils/mkmarkdown.py
landam Aug 19, 2024
816a49c
Update utils/mkmarkdown.py
landam Aug 19, 2024
40dbcb0
Update utils/mkmarkdown.py
landam Aug 19, 2024
753fab7
Update utils/mkmarkdown.py
landam Aug 19, 2024
84c55e6
Update utils/mkmarkdown.py
landam Aug 19, 2024
e9f31cb
Update man/build_md.py
landam Aug 19, 2024
44736a5
Update man/build_keywords.py
landam Aug 19, 2024
b36d707
Merge branch 'main' into markdown_docs
landam Aug 19, 2024
4ec91d5
fix compilation issue in 'man' dir
landam Aug 19, 2024
e71d72b
fix compilation issue in 'raster' dir
landam Aug 19, 2024
96c5b53
simplify mddesc
landam Aug 19, 2024
9460dee
parser: flag's description may be optional
landam Aug 19, 2024
3e3366b
point logo to index.html
landam Aug 20, 2024
f6255d8
mkdocs: customize site_name
landam Aug 20, 2024
e14483d
fix module indices
landam Aug 20, 2024
d56baaa
fix keywords
landam Aug 20, 2024
fbc81f0
fix guiscript
landam Aug 20, 2024
722b382
implement manual_gallery
landam Aug 20, 2024
d101d51
implement parser_standard_options
landam Aug 20, 2024
b7486e4
Update man/build_keywords.py
landam Aug 20, 2024
0cc3123
Update man/parser_standard_options.py
landam Aug 20, 2024
78b17f5
fix commit ref
landam Aug 20, 2024
723ee55
replace html meta comments with yaml metadata block
landam Aug 20, 2024
c7633b0
introduce build.py
landam Aug 20, 2024
46ff26a
fix building indices
landam Aug 20, 2024
1a74615
full index: avoid HTML tag in MD
landam Aug 20, 2024
7fcf163
simplify title
landam Aug 20, 2024
fa20022
Update man/build_topics.py
landam Aug 20, 2024
5458f76
Update man/build_md.py
landam Aug 20, 2024
b58d65b
Update man/build_md.py
landam Aug 20, 2024
2f6ed6d
Update man/build_full_index.py
landam Aug 20, 2024
0b000be
Update man/build_manual_gallery.py
landam Aug 20, 2024
deb7cac
Update man/build_class.py
landam Aug 20, 2024
fab2a0f
Update man/build.py
landam Aug 20, 2024
a6e625b
Update lib/gis/parser_rest_md.c
landam Aug 20, 2024
77d9f42
Merge branch 'main' into markdown_docs
landam Aug 20, 2024
3f05ec9
extend footer
landam Aug 20, 2024
50edf87
REQUIREMENTS.md: add pip install mkdocs mkdocs-material
neteler Aug 21, 2024
9ebb183
beautify footer
landam Aug 21, 2024
987d992
rename target dir to mkdocs
landam Aug 21, 2024
33a91b9
fix build_class
landam Aug 21, 2024
72dec30
add missing footer
landam Aug 22, 2024
4daa36b
apply black
landam Aug 22, 2024
d3b31d3
apply ruff suggestions
landam Aug 22, 2024
516386d
fix pathlib import
landam Aug 22, 2024
05cd9af
Update utils/mkmarkdown.py
landam Aug 22, 2024
4428a64
apply ruff
landam Aug 22, 2024
682d266
remove auto-generated md files
landam Sep 19, 2024
64ed659
Merge branch 'main' into markdown_docs
landam Sep 19, 2024
9d129e1
Update man/build_keywords.py
landam Sep 19, 2024
00a8c8f
solve conflicts
landam Sep 30, 2024
33753b1
Merge branch 'main' into markdown_docs
landam Sep 30, 2024
2353681
Merge branch 'main' into markdown_docs
landam Oct 6, 2024
1869b31
remove two overlooked MD files
landam Oct 6, 2024
c1581cb
manual merge from master
landam Oct 6, 2024
37c0c15
Update utils/mkmarkdown.py
landam Oct 6, 2024
8aa433b
Update man/build_md.py
landam Oct 6, 2024
6743f1a
fix PR compilation
landam Oct 6, 2024
77f50d3
remove print statements
landam Oct 6, 2024
9429ca7
disable build-mkdocs
landam Oct 6, 2024
7f3497d
Merge branch 'main' into markdown_docs
landam Oct 7, 2024
42a0c0d
npx prettier --print-width 80 -w man/mkdocs/mkdocs.yml
neteler Oct 9, 2024
25eb9a6
os.getcwd() -> Path.cwd()
neteler Oct 9, 2024
28f979a
libgis: module -> name in metadata
landam Oct 14, 2024
3daffab
apply ruff suggestions
landam Oct 14, 2024
3cd862f
apply ruff suggestions
landam Oct 14, 2024
6661c11
apply black
landam Oct 14, 2024
7e2a437
fix flake8 errors
landam Oct 17, 2024
c6a0a74
Merge branch 'main' into markdown_docs
landam Oct 17, 2024
350c8a3
solve multi-line-implicit-string-concatenation (ISC002)
landam Oct 18, 2024
fb75c27
Merge branch 'main' into markdown_docs
landam Oct 18, 2024
839892a
apply black
landam Oct 18, 2024
b486d2a
Merge branch 'main' into markdown_docs
landam Oct 21, 2024
767fe03
merge 870343f
landam Oct 21, 2024
c66cda8
seperate common part in mkhtml/mkmarkdown to mkdocs
landam Oct 24, 2024
f6ab247
apply black
landam Oct 24, 2024
54edbce
comment md-related parts in makefile
landam Oct 24, 2024
9e08f1b
Merge branch 'main' into markdown_docs
landam Oct 24, 2024
66fb33b
Update utils/mkmarkdown.py
landam Oct 24, 2024
00ade4d
Update utils/mkmarkdown.py
landam Oct 24, 2024
2a7434e
apply ruff suggestions
landam Oct 24, 2024
308556e
fix flake8 issues
landam Oct 24, 2024
dea8261
fix mkmarkdown
landam Oct 26, 2024
a43993a
cleanup mkmarkdown
landam Oct 26, 2024
f1379f3
cleanup mkhtml
landam Oct 26, 2024
2e5454c
fix import
landam Oct 26, 2024
1a77853
Merge branch 'main' into markdown_docs
landam Oct 26, 2024
2918609
remove commented blocks
landam Oct 26, 2024
e849291
remove todo comment
landam Oct 26, 2024
974d7f2
fix mkhtml.py: calling get_addon_path()
landam Oct 26, 2024
ac5e963
remove leftover HTML code in MD part
neteler Oct 26, 2024
a1fc15e
remove leftover HTML code in MD part
neteler Oct 26, 2024
c2bdf4d
fix keywords (HTML version)
landam Nov 4, 2024
3dec812
Merge branch 'main' into markdown_docs
echoix Nov 5, 2024
92898df
micro white space fix
neteler Nov 7, 2024
d45c0b6
add pyyaml-env-tag to man/mkdocs/requirements.txt
landam Nov 10, 2024
11011e2
Update man/mkdocs/requirements.txt
landam Nov 10, 2024
ad6170a
remove duplicated pyyaml-env-tag from man/mkdocs/requirements.txt
landam Nov 10, 2024
9be5d69
Update REQUIREMENTS.md
landam Nov 10, 2024
f59b0db
Merge branch 'main' into markdown_docs
landam Nov 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Merge branch 'main' into markdown_docs
landam authored Oct 26, 2024

Verified

This commit was signed with the committer’s verified signature.
sdstolworthy Spencer Stolworthy
commit 1a77853eb5ae76608b669a18ebb4fb841c919116

This merge commit was added into this branch cleanly.

There are no new changes to show, but you can still view the diff.