[prototype] Add initial table of software projects #5
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.
This PR creates a Nox session to generate a Markdown file containing a table of software projects. This file is then included in a Markdown page for software projects. This was inspired by the PyHC projects page created by @sapols.
I tentatively chose TOML as the format for the software projects data file, but I'd be content to go with YAML instead.
This PR initially uses
py-markdown-table, which is a pretty light dependency. Another possibility would bepytablewriter, which has more extensive functionality.We'll likely want to do some processing of the contents being read in from the TOML file. For example, the PyHC projects page uses the GitHub or GitLab icon for the repository, a books icon for the documentation, and a 🌐 icon for the page on the World Wide Web.
I put functionality directly in
noxfile.pyfor the prototype, but I suspect we'll want to refactor it into a separate Python script.