Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
totutorials/documentation_rtd.md
: Renamed the existing documentation tutorial to specify that it is for Read The Docs.