-
Notifications
You must be signed in to change notification settings - Fork 7
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
Switch from sphinx to use mkdocs #209
Conversation
ens-LCampbell
commented
Nov 14, 2023
- Initial set up configs
- Workflow update
- MD file creation
- auto docs gen_reference MD script
- Revert sphinx to backup and update build script
- Update project TOML for mkdocs/sphinx distinction
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would personally drop docs/sphinx/source
, scripts/setup/docs/build_sphinx_docs.sh
and the sphinx
label in pyproject, but besides that great addition 📜 I have done just a few minor suggestions on code cleanup and such.
I have a feeling some of these documents could be pulled from their original source to be generated/updated, e.g. license.md
, but that can be done in a later stage (if needed).
Note: unless it is required to be this way, mkdocs.yaml
should be mkdocs.yml
mkdocs.yaml
Outdated
@@ -0,0 +1,31 @@ | |||
# mkdocs.yml | |||
site_name: Ensembl-GenomIO (v0.1) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as before.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've removed the versioning information, changed the name to Ensembl GenomIO
. Also removed Sphinx legacy scripts, source etc as suggested. If we can get from git history then fine by me.
docs/index.md
Outdated
@@ -0,0 +1,92 @@ | |||
# [Ensembl-genomIO (v0.1)](https://github.com/Ensembl/ensembl-genomio) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unless there is a way to pull the version information from the Python code, I would be reluctant to have it here as it is really likely we forget to update this at the same time as in the Python code (unless we add a check for it).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we either want to do Ensembl GenomIO
or ensembl-genomio
("official name" vs pypy library).
add code snippet to improve readability Co-authored-by: J. Alvarez-Jarreta <[email protected]>
Update install instructions Co-authored-by: J. Alvarez-Jarreta <[email protected]>
Update to PERL deps Co-authored-by: J. Alvarez-Jarreta <[email protected]>
remove debug lines Co-authored-by: J. Alvarez-Jarreta <[email protected]>
remove unused comments Co-authored-by: J. Alvarez-Jarreta <[email protected]>
remove unused comments Co-authored-by: J. Alvarez-Jarreta <[email protected]>
remove unused comments Co-authored-by: J. Alvarez-Jarreta <[email protected]>
Update required python modules Co-authored-by: J. Alvarez-Jarreta <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks quite neat 👀
Thank you Co-authored-by: J. Alvarez-Jarreta <[email protected]>
Co-authored-by: J. Alvarez-Jarreta <[email protected]>