Docs Modernization and Glyphs major update#1
Open
mtripnaux wants to merge 35 commits intoEdinburgh-Genome-Foundry:masterfrom
Open
Docs Modernization and Glyphs major update#1mtripnaux wants to merge 35 commits intoEdinburgh-Genome-Foundry:masterfrom
mtripnaux wants to merge 35 commits intoEdinburgh-Genome-Foundry:masterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I used Jinja2 for HTML templating, and the documentation code is now located under /templates.
Two python scripts are available under /source. The first one builds the CSS standalone file from the SVG folder and creates a JSON file to describe the icons, their names and paths. These two files are built in the /dist directory. The second script builds the documentation from templates, taking in account the JSON file (displays the glyph count, lists the CSS classes, etc).
The github pages integration is now using the Github Actions framework, with an automated build pipeline that builds the entire /dist folder from sources at each pushed commit. The /dist is then served in the repo's Pages.
5 SVGs were added :
source/SVG/aptamer.svgsource/SVG/inert-dna-spacer.svgsource/SVG/origin-of-transfer.svgsource/SVG/stop-codon.svgsource/SVG/poly-a-site.svg14 SVGs were modified to look better on screen :
source/SVG/engineered-region.svgsource/SVG/five-prime-sticky-restriction-site.svgsource/SVG/three-prime-sticky-restriction-site.svgsource/SVG/five-prime-overhang.svgsource/SVG/three-prime-overhang.svgsource/SVG/user-defined.svgsource/SVG/origin-of-replication.svgsource/SVG/insulator.svgsource/SVG/operator.svgsource/SVG/assembly-scar.svgsource/SVG/blunt-restriction-site.svgsource/SVG/cds.svg