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

Switch from sphinx to use mkdocs #209

Merged
merged 15 commits into from
Nov 15, 2023
Merged

Conversation

ens-LCampbell
Copy link
Member

  • 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

Copy link
Contributor

@JAlvarezJarreta JAlvarezJarreta left a 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

docs/usage.md Outdated Show resolved Hide resolved
mkdocs.yaml Outdated
@@ -0,0 +1,31 @@
# mkdocs.yml
site_name: Ensembl-GenomIO (v0.1)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as before.

Copy link
Member Author

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)
Copy link
Contributor

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).

Copy link
Contributor

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).

docs/install.md Outdated Show resolved Hide resolved
docs/install.md Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
docs/gen_ref_pages.py Outdated Show resolved Hide resolved
docs/gen_ref_pages.py Outdated Show resolved Hide resolved
docs/gen_ref_pages.py Outdated Show resolved Hide resolved
docs/gen_ref_pages.py Outdated Show resolved Hide resolved
ens-LCampbell and others added 10 commits November 14, 2023 15:17
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]>
@MatBarba MatBarba changed the base branch from hackathon_nov23 to main November 15, 2023 11:21
Copy link
Contributor

@JAlvarezJarreta JAlvarezJarreta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks quite neat 👀

docs/index.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
ens-LCampbell and others added 2 commits November 15, 2023 11:34
Thank you

Co-authored-by: J. Alvarez-Jarreta <[email protected]>
Co-authored-by: J. Alvarez-Jarreta <[email protected]>
@ens-LCampbell ens-LCampbell merged commit 8f57374 into main Nov 15, 2023
@JAlvarezJarreta JAlvarezJarreta deleted the lcampbell/mkdocs_deploy branch November 21, 2023 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants