Skip to content

mkdocs deployment#417

Merged
guzman-raphael merged 4 commits intodatajoint:masterfrom
CBroz1:master
Dec 8, 2022
Merged

mkdocs deployment#417
guzman-raphael merged 4 commits intodatajoint:masterfrom
CBroz1:master

Conversation

@CBroz1
Copy link
Contributor

@CBroz1 CBroz1 commented Nov 8, 2022

This PR

  • Removes all docs-parts, as they are now folded into md versions of the original rst docs proposed to be kept in in an archive directory as part of datajoint-docs PR 18
  • Adds a doc contributor README with notes about vscode extensions that can aid in further contributions, including...
    • markdownlint for markdown linting
    • CSpell for spell checking
    • ReWrap for hard wrapping. While not necessary, this will help visualizing future git diffs.
  • Migrates docs from docs.datajoint.org in a manner that mirrors the structure of datajoint-docs PR 18. While the central docs explain concepts, these submissions provide more concrete examples.
  • Add CICD to deploy docs
  • Adjust all examples to table definitions shown within the docs
  • Final proof read pass
  • Updated styling following DLC #63

Still needs

  • Review/suggestions from @yambottle regarding CICD and turn on gh-pages

Note that not all the checks below will pass because I am issuing a PR to master rather than staging per advice of @guzman-raphael

@CBroz1 CBroz1 marked this pull request as ready for review November 9, 2022 17:13
@kabilar kabilar assigned kabilar and guzman-raphael and unassigned kabilar Nov 11, 2022
@guzman-raphael guzman-raphael merged commit 14d815b into datajoint:master Dec 8, 2022
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