Migrate user guide/examples to mkdocs #470

qiaojunfeng · 2024-02-15T17:21:40Z

The original latex code is converted to markdown files
examples renamed to tutorials
Added logos

TODO:

Enable github pages for the repo?
Migrate solution booklet to markdown

Using pandoc and mkdocs

To auto-number/crossref latex equations.

* Update format for `Postw90` and `Appendices` * Update equations and notes format

Fix mrkdown file wannier90/notes_interpolations.md

* Fix markdown file for parameters chapter * Fix a custom latex command

Fix a reference in postw90params.md

Fix the ref labels and links. Unified the notes format. Minor format fixes.

Fix a reference in postw90params.md

Fix the ref labels and links. Unified the notes format. Minor format fixes.

giovannipizzi

Thanks! A couple of small things

let's remove all warnings and convert warnings to errors in the CI (with the --strict option of mkdocs build)
let's add some content on the home page
add a way to see the compiled docs of a PR

Since now tutorial has migrated to mkdocs/html, we do not need to keep the old versions (that will anyway get outdated if left there, and generate confusion on which is the official documentation)

… tutorials files

giovannipizzi

Thanks! Great work @qiaojunfeng @VVitale @jiang-yuha0 @npaulish !

qiaojunfeng and others added 30 commits February 13, 2024 10:25

Convert latex user guide to markdown

13ff0ae

Using pandoc and mkdocs

Update

d8f5395

Switch to mathjax

047f32a

To auto-number/crossref latex equations.

Add macro for bm

7e95ef8

Use gfm flavor tables

7390d5c

Fix projections

b7d0585

Fix projections

4e17398

Fix lib mode

82e8910

Add overview.webp

f6accf4

Fix markdown files for postw90 and appendices (#1)

2968dc2

* Update format for `Postw90` and `Appendices` * Update equations and notes format

Fix markdown file (#2)

df40bb0

Fix mrkdown file wannier90/notes_interpolations.md

Fix transport

797f9f4

Fix files

136057e

Firt five tutorials for online version

027125d

Fix markdown file for parameters chapter (#3)

7a7b89b

* Fix markdown file for parameters chapter * Fix a custom latex command

17 tutorials for online version

3fbd067

Add Section postw90/parameters

aaba067

Fix tables in postw90/parameters.md file

7eb04b2

Fix a reference in postw90params.md

Update some links

8ebeb89

24 tutorials for online version

01987ae

Added tutorial.md

f257c50

Check the format of markdown files.

74de353

Fix the ref labels and links. Unified the notes format. Minor format fixes.

29 tutorials for online version

3078e54

Fixing rendering of equations in t18 e t27

5f71b15

Remove absolute number in cross-file equation ref

b8883a4

Add Section postw90/parameters

5cf2ccf

Fix tables in postw90/parameters.md file

dfd1daa

Fix a reference in postw90params.md

Update some links

836d7f4

Check the format of markdown files.

77a4977

Fix the ref labels and links. Unified the notes format. Minor format fixes.

Remove absolute number in cross-file equation ref

b6c7c44

Valerio and others added 7 commits February 15, 2024 17:40

Added logos folder into the docs

4af6254

Set logo

0a4717f

Minor fixes in the docs

ac55316

Merge remote-tracking branch 'upstream/develop' into mkdocs

d0f8b00

Cleanup mkdocs yaml

48b76b4

Fix precommit hook for mkdocs.yml

7cf33db

Add github workflow for mkdocs

dfdb98c

qiaojunfeng force-pushed the mkdocs branch 2 times, most recently from d66ebe5 to f875ef2 Compare February 16, 2024 09:25

Add CI for docs test

743c0d4

qiaojunfeng force-pushed the mkdocs branch from f875ef2 to 743c0d4 Compare February 16, 2024 09:31

giovannipizzi reviewed Feb 16, 2024

View reviewed changes

Removing old latex and PDF

d451940

Since now tutorial has migrated to mkdocs/html, we do not need to keep the old versions (that will anyway get outdated if left there, and generate confusion on which is the official documentation)

giovannipizzi mentioned this pull request Feb 16, 2024

Fix typo in tutorial about Tungsten #456

Closed

qiaojunfeng and others added 6 commits February 16, 2024 11:29

Fix md links

aa220a3

Enable strict mode of mkdocs

2bf895b

Update docs home

1566bdf

fixing link to equation in tutorial 29

669a346

Fixing paths to the correct tutorial folder on the github repo in the…

4a5902a

… tutorials files

Change docs color

2767a46

qiaojunfeng force-pushed the mkdocs branch 2 times, most recently from efc4515 to 37fc9b0 Compare February 16, 2024 12:20

Use GITHUB_TOKEN

97fc484

qiaojunfeng force-pushed the mkdocs branch from 37fc9b0 to 97fc484 Compare February 16, 2024 12:30

qiaojunfeng mentioned this pull request Feb 16, 2024

typo in user_guide #428

Closed

Merge remote-tracking branch 'upstream/develop' into mkdocs

89a9a7c

qiaojunfeng mentioned this pull request Feb 16, 2024

Fixing typo in Omega_I #450

Closed

giovannipizzi approved these changes Feb 16, 2024

View reviewed changes

giovannipizzi merged commit 749315b into wannier-developers:develop Feb 16, 2024
4 checks passed

giovannipizzi mentioned this pull request Feb 16, 2024

Move Documentation and Tutorial to web page #119

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate user guide/examples to mkdocs #470

Migrate user guide/examples to mkdocs #470

qiaojunfeng commented Feb 15, 2024 •

edited

Loading

giovannipizzi left a comment •

edited

Loading

giovannipizzi left a comment

Migrate user guide/examples to mkdocs #470

Migrate user guide/examples to mkdocs #470

Conversation

qiaojunfeng commented Feb 15, 2024 • edited Loading

giovannipizzi left a comment • edited Loading

Choose a reason for hiding this comment

giovannipizzi left a comment

Choose a reason for hiding this comment

qiaojunfeng commented Feb 15, 2024 •

edited

Loading

giovannipizzi left a comment •

edited

Loading