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

📚 Add documentation and support for its deployment to GitHub Pages #181

Merged
merged 31 commits into from
Nov 13, 2024
Merged

📚 Add documentation and support for its deployment to GitHub Pages #181

merged 31 commits into from
Nov 13, 2024

Conversation

Michele-Alberti
Copy link
Owner

Feat
Remove text before doc-start anchor, add front matter and title in README.md (see generate_getting_started.py).

Refactor
Move dlunch __version__ from __init__.py to core.py.

Build

  • add docs folder to .dockerignore
  • improve makefile
  • fix optional-dependencies to be dynamically evaluated in pyproject.toml
  • add docs and dev optional dependencies

Docs

  • improve docs
  • add MkDocs to auto-generate documentation (uses MkDocs-Material template)
  • add Python support scripts to auto-generate dlunch docs from docstrings and to convert README.md to a getting started page
  • Test Sphinx (removed in favor of MkDocs)

CI

  • update pre-commit
  • update cryptography
  • add workflow to deploy documentation to github pages

Closes #30.

github-actions bot and others added 30 commits July 17, 2024 21:23
@github-actions
Merge branch 'main' into development
aa8c07f
@pre-commit-ci @Michele-Alberti
ci(.pre-commit-config.yaml): pre-commit autoupdate
7fe85f7 
updates:
- [github.com/psf/black: 24.4.2 → 24.10.0](psf/black@24.4.2...24.10.0)
- [github.com/pycqa/flake8: 7.1.0 → 7.1.1](PyCQA/flake8@7.1.0...7.1.1)
- [github.com/commitizen-tools/commitizen: v3.27.0 → v3.30.0](commitizen-tools/commitizen@v3.27.0...v3.30.0)
@dependabot @Michele-Alberti
build(deps): bump cryptography
733035a 
Bumps the pip group with 1 update in the /requirements directory: [cryptography](https://github.com/pyca/cryptography).


Updates `cryptography` from 42.0.8 to 43.0.1
- [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst)
- [Commits](pyca/cryptography@42.0.8...43.0.1)

---
updated-dependencies:
- dependency-name: cryptography
  dependency-type: direct:production
  dependency-group: pip
...

Signed-off-by: dependabot[bot] <support@github.com>
@Michele-Alberti
build(environment.yml): update cryptography in conda environment
7c6b7c7
@Michele-Alberti
ci(.pre-commit-config.yaml): update pre-commit config
44c21d5
@Michele-Alberti
docs: improve docstrings and adopt google docstring format
2a5102d
@Michele-Alberti
docs: add sphinx to project to build documentation static site
b033947 
add sphinx to main conda environment
add rules to makefile to build and launch a test server
add sphinx config files
add sphinx version to pyproject.toml (commitizen)
@Michele-Alberti
build(.dockerignore): add docs folder to .dockerignore
b5951a1
@Michele-Alberti
build(makefile): improve clean-folders rule
66d3b8d
@Michele-Alberti
refactor(__version__): move dlunch __version__ from __init__.py to co…
46ece93 
…re.py

__version__ is still imported in __init__.py
@Michele-Alberti
docs(conf.py): add github url
036b1a9
@Michele-Alberti
docs: change docs engine to mkdocs (previously was sphinx)
415cec2 
closes #30
@Michele-Alberti
ci: add step name in ci_cd.yaml and improve 'Set Git config' step in …
630972f 
…bump_version.yaml
@Michele-Alberti
build(makefile): improve clean-folders rule
3c83d2b
@Michele-Alberti
docs: add mike for mkdocs
d96fa72 
add mike also to environment.yml
@Michele-Alberti
build: add docs optional dipendencies to pyproject.toml
5274854 
docs dynamic dependencies are given through docs-requirements.txt
@Michele-Alberti
build(pyproject.toml): fix optional-dependencies to be dynamically ev…
b2a40a8 
…aluated
@Michele-Alberti
ci(deploy_docs.yaml): add workflow to deploy docs with mkdocs and mike
a927770
@Michele-Alberti
ci(deploy_docs.yaml): change latest from alias to identifier
3e2c9c0
@pre-commit-ci @Michele-Alberti
ci(.pre-commit-config.yaml): pre-commit autoupdate
35d1c49 
updates:
- [github.com/commitizen-tools/commitizen: v3.30.0 → v3.30.1](commitizen-tools/commitizen@v3.30.0...v3.30.1)
@dependabot @Michele-Alberti
build(deps): bump commitizen-tools/commitizen-action
c9c2ff5 
Bumps the gh-minor-deps group with 1 update: [commitizen-tools/commitizen-action](https://github.com/commitizen-tools/commitizen-action).


Updates `commitizen-tools/commitizen-action` from 0.21.0 to 0.22.0
- [Release notes](https://github.com/commitizen-tools/commitizen-action/releases)
- [Changelog](https://github.com/commitizen-tools/commitizen-action/blob/master/CHANGELOG.md)
- [Commits](commitizen-tools/commitizen-action@0.21.0...0.22.0)

---
updated-dependencies:
- dependency-name: commitizen-tools/commitizen-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: gh-minor-deps
...

Signed-off-by: dependabot[bot] <support@github.com>
@Michele-Alberti
build(makefile): improve commands to add serve with mike
1896fc2
@Michele-Alberti
docs: improve index.md and fix mkdocs.yml to work with mike
1194220
@Michele-Alberti
build(makefile): remove echo for docs serve rules
c042a53
@Michele-Alberti
build(add-dev-requirements): add jupyter lab to development requirements
4839f77
@Michele-Alberti
docs(mkdocs.yml): change navbar
84db787
@Michele-Alberti
docs(README.md): remove section numbers and add doc-start anchor
ca2ee97
@Michele-Alberti
feat(generate_getting_started.py): remove text before doc-start ancho…
158a002 
…r, add front matter and title in README.md

this changes create a better getting started page
@Michele-Alberti
docs(index.md): add front matter
643bf0c
@Michele-Alberti
docs(mkdocs.yml): improve nav section and add navigation features
6209d5a
@Michele-Alberti
docs(improve-docs-styling-with-css-rules): fix also indentation in ap…
bbf39c6 
…p_header.css and labels.css (not inside docs)
@Michele-Alberti Michele-Alberti added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 13, 2024
@Michele-Alberti Michele-Alberti self-assigned this Nov 13, 2024
@Michele-Alberti Michele-Alberti changed the title Development 📚 Add documentation and support for its deployment to GitHub Pages Nov 13, 2024
@Michele-Alberti Michele-Alberti merged commit 706d855 into main Nov 13, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@Michele-Alberti Michele-Alberti

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

📚 Update docs
1 participant
@Michele-Alberti