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.

Sign up for GitHub

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

Jump to bottom

Update documentation #180

Merged
merged 56 commits into from
Dec 5, 2023
Merged

Update documentation #180

merged 56 commits into from
Dec 5, 2023

Conversation

naik-aakash
Copy link
Collaborator

@naik-aakash naik-aakash commented Nov 2, 2023 •
edited
Loading

Closes #103 , #130, #163

  • Update readme
  • Add contributing guidelines
  • Add optional dependencies for the development version
  • Update dependencies/documentation theme
  • Update tutorial
  • Document bonding-antibonding contribution and orbital-wise implementation
  • Add missing coxx_edge as feature
  • Mention how to use with other code outputs besides VASP using POSCAR.lobster in cli and python interface
  • Add coxx_edge as feature in tutorial
  • Fix args and attributes mixed up in doc-strings
  • Add example for batch-structure graphs in tutorial
  • Add DOS featurizer
  • Add DOS featurizer example in tutorial
  • Update code contribution guidelines
  • Update fundamentals section to depict algorithm workings using figures. Showcase the results for several examples of different complexity (Closes document bonding, antibonding contribution and orbital wise implementation #163)
  • Add more python scripts in examples
  • Check all doc-string and formatting
  • Check tutorial and fundamentals texts for errors or inconsistencies

@naik-aakash naik-aakash changed the title Update documentation [WIP] Update documentation Nov 2, 2023
naik-aakash and others added 25 commits November 3, 2023 22:17
@naik-aakash
update files
9a939da
@naik-aakash
update docs source files
60aca57
@naik-aakash
fix sphinx version
11ab252
@naik-aakash
update docs, tutorials, layout
a3a2f48
@naik-aakash
resolve merge conflicts
cee1753
@naik-aakash
update conf.py path in documentation workflow and tests
9bdea19
@naik-aakash
Merge branch 'main' into update_documentation
3561092
@naik-aakash
fix linting
834e52a
@naik-aakash
fix example files paths~
cf58700
@naik-aakash
fix docs cli help issue
41cc1da
@naik-aakash
increase nb execution timeout limt
1a3adcf
@naik-aakash
fix non-consecutive heading sizes
20ecee8
@naik-aakash
add autosummary templates
170b04a
@naik-aakash
make doc build test stringent
1e5549b
@naik-aakash
fix multiline docstrings rendering in doc issue sg, plotting module
14f728d
@naik-aakash
Merge branch 'JaGeo:main' into update_documentation
d913de0
@naik-aakash
Merge branch 'JaGeo:main' into update_documentation
5884510
@naik-aakash
Merge branch 'JaGeo:main' into update_documentation
a86ff6a
@naik-aakash
Merge branch 'JaGeo:main' into update_documentation
e8efcdc
@naik-aakash
remove duplicate docstring for doscar featurizer
065eb44
@naik-aakash
add link to new documentation in README text
b1a5b37
@naik-aakash
add custom.css to edit doc appearance
64283ee
@naik-aakash
add repo icon to doc
15bdc0d
@naik-aakash
fix docstring typo
bdba61e
@naik-aakash
add logo to html doc
8acbad8
@naik-aakash naik-aakash self-assigned this Nov 25, 2023
@naik-aakash naik-aakash added the documentation Improvements or additions to documentation label Nov 25, 2023
@JaGeo
Copy link
Owner

JaGeo commented Nov 27, 2023

👀 BAM and you are fast

@naik-aakash
Copy link
Collaborator Author

👀 BAM and you are fast

Haha no, did not get any laptop yet. I was using Joanas laptop when she was attending german class and the optics lectures 😄

@naik-aakash naik-aakash changed the title [WIP] Update documentation Update documentation Dec 4, 2023
JaGeo
JaGeo reviewed Dec 5, 2023
View reviewed changes
docs/fundamentals/index.ipynb Outdated Show resolved Hide resolved
JaGeo
JaGeo requested changes Dec 5, 2023
View reviewed changes
Copy link
Owner

@JaGeo JaGeo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more little change that I will merge.

@JaGeo JaGeo merged commit 140c6f0 into JaGeo:main Dec 5, 2023
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JaGeo JaGeo JaGeo approved these changes

Assignees

@naik-aakash naik-aakash

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

document bonding, antibonding contribution and orbital wise implementation Update readme
2 participants
@naik-aakash @JaGeo