Skip to content

doc: Consolidate documents#450

Open
LecrisUT wants to merge 2 commits into
spglib:developfrom
LecrisUT:doc/consolidate
Open

doc: Consolidate documents#450
LecrisUT wants to merge 2 commits into
spglib:developfrom
LecrisUT:doc/consolidate

Conversation

@LecrisUT

@LecrisUT LecrisUT commented Feb 26, 2024

Copy link
Copy Markdown
Collaborator
  • Unify documentations
    • README.md -> docs/index.md
    • test/README.md -> docs/test.md
    • Contributing.md -> docs/development/index.md
    • fortran/README.md -> docs/interface/fortran.md
    • python/README.rst -> python/README.md -> docs/interface/python.md
  • Reorganize the documents
  • Improve the documentation contents

Closes #389, closes #305

Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT

LecrisUT commented Feb 26, 2024

Copy link
Copy Markdown
Collaborator Author

@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 push

It would be best to use sphinx-autobuild to get live preview of the contents

@codecov

codecov Bot commented Feb 26, 2024

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.59%. Comparing base (f1ff014) to head (87cd0f4).
⚠️ Report is 294 commits behind head on develop.

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           
Flag Coverage Δ
c_api 74.43% <ø> (ø)
fortran_api 56.16% <ø> (ø)
python_api 79.70% <ø> (ø)
unit_tests 13.47% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@LecrisUT

Copy link
Copy Markdown
Collaborator Author

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.md

But we should look at other references like the ones mentioned in #389

@atztogo

atztogo commented Feb 26, 2024

Copy link
Copy Markdown
Collaborator

@LecrisUT, I am not familiar with git. I tried to change same as #449 as a part of "Improve the documentation contents" (am I correctly understanding what you mean in this PR?), but failed. I have no immediate change other than that, so please go ahead, and call me whenever you want.

@LecrisUT

Copy link
Copy Markdown
Collaborator Author

@LecrisUT, I am not familiar with git. I tried to change same as #449 as a part of "Improve the documentation contents" (am I correctly understanding what you mean in this PR?), but failed. I have no immediate change other than that, so please go ahead, and call me whenever you want.

Ok, we can workshop that part in #449, and I will cherry-pick/rebase the contents later. Mainly the content should be in README.md after this PR.

@atztogo

atztogo commented Feb 26, 2024

Copy link
Copy Markdown
Collaborator

Ok, we can workshop that part in #449, and I will cherry-pick/rebase the contents later. Mainly the content should be in README.md after this PR.

Thanks. In case it is easier, it can be done just copy & paste, and I will close #449.

@LecrisUT

Copy link
Copy Markdown
Collaborator Author

Ok, we can workshop that part in #449, and I will cherry-pick/rebase the contents later. Mainly the content should be in README.md after this PR.

Thanks. In case it is easier, it can be done just copy & paste, and I will close #449.

No worries, I can handle that, and I would prefer to have it easily navigate the discussions anyway.

@lan496

lan496 commented Feb 26, 2024

Copy link
Copy Markdown
Member

I would suggest to rename "physics" section to other more appropirate one line "concepts".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reorganize concept documents for crystallography and spglib's convention Synchronize content of README.md to index.md page

3 participants