doc: Consolidate documents#450
Conversation
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
|
@atztogo @lan496 For this PR please go ahead and push/merge/rebase however you want on my branch, I will clean things later $ git remote add LecrisUT git@github.com:LecrisUT/spglib.git
$ git fetch LecrisUT
$ git pull --rebase
$ git pushIt would be best to use |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #450 +/- ##
========================================
Coverage 83.59% 83.59%
========================================
Files 24 24
Lines 8118 8118
Branches 1688 1688
========================================
Hits 6786 6786
Misses 1332 1332
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
My initial sketch of the organization is: $ tree -I "_build" -I "python-api" --dirsfirst ./doc
./doc
├── api
│ ├── c
│ │ └── index.md
│ ├── fortran
│ │ └── index.md
│ ├── python
│ │ └── index.md
│ ├── develop.md
│ └── index.md
├── development
│ ├── develop.md
│ ├── magnetic_symmetry_flags.md
│ └── performance.md
├── interface
│ ├── c.md
│ ├── fortran.md
│ ├── index.md
│ ├── julia.md
│ ├── python.md
│ ├── rust.md
│ └── variable.md
├── physics
│ ├── dataset.md
│ ├── definition.md
│ ├── magnetic_dataset.md
│ └── variable.md
├── _static
│ ├── change-of-basis.ai
│ └── change-of-basis.png
├── codespell.txt
├── conf.py
├── index.md
├── Makefile
├── README.md
├── references.bib
├── references.md
└── releases.mdBut we should look at other references like the ones mentioned in #389 |
Ok, we can workshop that part in #449, and I will cherry-pick/rebase the contents later. Mainly the content should be in |
No worries, I can handle that, and I would prefer to have it easily navigate the discussions anyway. |
|
I would suggest to rename "physics" section to other more appropirate one line "concepts". |
Closes #389, closes #305