Add Sphinx project documentation#1
Conversation
Reviewer's GuideAdds a full Sphinx documentation scaffold (with Read the Docs theme) for the project, including build tooling, configuration for Read the Docs, Python doc requirements, and initial documentation structure with placeholder .rst files for key topics. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 2 issues, and left some high level feedback:
- Consider adding the Sphinx build output directory (e.g.
docs/build/) to.gitignoreso generated HTML artifacts don’t end up committed. - In
docs/source/conf.py, you may want to setversion/releasedynamically from the project package instead of hardcoding'1.0'to avoid having to update this file on every release. - The
.readthedocs.yamlfile pins Python to 3.7; if the project targets a different version in production, it would be safer to align this to the same Python version to avoid subtle discrepancies in behavior or dependencies.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider adding the Sphinx build output directory (e.g. `docs/build/`) to `.gitignore` so generated HTML artifacts don’t end up committed.
- In `docs/source/conf.py`, you may want to set `version`/`release` dynamically from the project package instead of hardcoding `'1.0'` to avoid having to update this file on every release.
- The `.readthedocs.yaml` file pins Python to 3.7; if the project targets a different version in production, it would be safer to align this to the same Python version to avoid subtle discrepancies in behavior or dependencies.
## Individual Comments
### Comment 1
<location path=".readthedocs.yaml" line_range="6" />
<code_context>
+build:
+ os: ubuntu-24.04
+ tools:
+ python: "3.7"
+
+sphinx:
</code_context>
<issue_to_address>
**🚨 issue (security):** Using Python 3.7 on Read the Docs may cause compatibility and security issues.
Since 3.7 is EOL and many tools/dependencies are dropping support for it, it’d be safer to use the same (newer) Python version here as the project’s runtime to avoid subtle behavior differences and future dependency breakage.
</issue_to_address>
### Comment 2
<location path="docs/source/presentation.rst" line_range="1" />
<code_context>
+Présentation du projet
+======================
+
</code_context>
<issue_to_address>
**issue (bug_risk):** Présence probable d’un BOM UTF-8 au début du fichier.
Ce marqueur peut provoquer des comportements inattendus avec certains outils. Merci de le supprimer afin que le fichier soit encodé en UTF-8 sans BOM, comme les autres.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| build: | ||
| os: ubuntu-24.04 | ||
| tools: | ||
| python: "3.7" |
There was a problem hiding this comment.
🚨 issue (security): Using Python 3.7 on Read the Docs may cause compatibility and security issues.
Since 3.7 is EOL and many tools/dependencies are dropping support for it, it’d be safer to use the same (newer) Python version here as the project’s runtime to avoid subtle behavior differences and future dependency breakage.
| @@ -0,0 +1,58 @@ | |||
| Présentation du projet | |||
There was a problem hiding this comment.
issue (bug_risk): Présence probable d’un BOM UTF-8 au début du fichier.
Ce marqueur peut provoquer des comportements inattendus avec certains outils. Merci de le supprimer afin que le fichier soit encodé en UTF-8 sans BOM, comme les autres.
Modifications
.readthedocs.yaml.Vérification
.\make.bat html;Summary by Sourcery
Add a Sphinx-based documentation site and hosting configuration for the project.
Build:
Documentation: