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

Updates on our documentation to fix a few minor issues and add new features #223

Merged
merged 9 commits into from
Nov 24, 2023

Conversation

JAlvarezJarreta
Copy link
Contributor

@JAlvarezJarreta JAlvarezJarreta commented Nov 23, 2023

Items:

  • I have opted to have an e! logo rather the mkdocs one (for the time being)
  • Added missing __all__ entries
  • Code reference only displays fromensembl level
    • ensembl.brc4 is shown as before (with .py included in the runnable name)
    • ensembl.io only display at module level, e.g. ensembl.io.genomio.assembly and not ensembl.io.genomio.assembly.download
  • Added light/dark mode
  • Added permalinks for easy reference

Whilst some code updates, ensembl.brc4 behaves the same as before whilst
ensembl.io will show all the elements inherited at the module level,
skipping showing how the module is actually divided in files.
@JAlvarezJarreta JAlvarezJarreta changed the title Updates a few minor elements in the documentation to test a few features Updates on our documentation to fix a few minor issues and add new features Nov 24, 2023
@JAlvarezJarreta
Copy link
Contributor Author

JAlvarezJarreta commented Nov 24, 2023

As suggested by @ens-LCampbell, I have pushed these changes to http://ensembl.github.io/ensembl-genomio so you can see how the documentations looks like with these changes.

Copy link
Member

@ens-LCampbell ens-LCampbell left a comment

Choose a reason for hiding this comment

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

Happy to merge. Happy with functionality upon testing 👍 Looks great I must say :)

@JAlvarezJarreta JAlvarezJarreta merged commit 39c2b6a into main Nov 24, 2023
1 check passed
@JAlvarezJarreta JAlvarezJarreta deleted the jalvarez/minor_fix branch November 24, 2023 16:00
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.

3 participants