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.

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

New doc instructions, black #91

Merged
merged 4 commits into from
Jan 9, 2025
Merged

New doc instructions, black #91

merged 4 commits into from
Jan 9, 2025

Conversation

jrzkaminski
Copy link
Contributor

This pull request includes multiple changes to the documentation, primarily focused on adding new tutorials and updating existing ones. The most important changes include the addition of tutorials for autoformatting code with Black, creating documentation with MkDocs, and updating the documentation links in the README files.

Documentation updates:

  • README.md: Updated links to documentation tutorials, including new entries for MkDocs and Read The Docs.
  • README_en.md: Updated the link to the documentation tutorial to point to the Read The Docs guide.

New tutorials:

  • tutorials/black_autoformatting.md: Added a new tutorial for autoformatting Python code using Black, including installation instructions and GitHub Actions configuration.
  • tutorials/documentation_mkdocs.md: Added a new tutorial for creating project documentation using MkDocs Material, including setup, configuration, and deployment instructions.

Renamed files:

  • tutorials/documentation.md to tutorials/documentation_rtd.md: Renamed the existing documentation tutorial to specify that it is for Read The Docs.

@jrzkaminski jrzkaminski merged commit af98d11 into master Jan 9, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants