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

Mkdocs deployment #1063

Merged
merged 6 commits into from
Nov 11, 2022
Merged

Mkdocs deployment #1063

merged 6 commits into from
Nov 11, 2022

Conversation

CBroz1
Copy link
Contributor

@CBroz1 CBroz1 commented Nov 8, 2022

This PR

  1. 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
  2. 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.
  3. 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.
  4. Temporarily changes the API page rendering to expect our current rst/sphinx docstring style, pending future updates to migrate to google style.
  5. Changes CSS to reflect changes elsewhere
    • md-code-fg-color to dj-primary
    • removes 'previous'/'next' footer via md-footer

Still needs

  • Updated styling following DLC #63

@CBroz1 CBroz1 marked this pull request as ready for review November 8, 2022 18:01
Copy link
Contributor

@kabilar kabilar left a comment

Choose a reason for hiding this comment

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

Thanks @CBroz1! Great effort with this migration.

I did not review all the text in detail, but our team will collectively review and update over the next 1-2 months.

@kabilar kabilar merged commit 7f6d76a into datajoint:master Nov 11, 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.

2 participants