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

Migrate documentation #60

Open
13 of 32 tasks
grst opened this issue Nov 18, 2024 · 0 comments
Open
13 of 32 tasks

Migrate documentation #60

grst opened this issue Nov 18, 2024 · 0 comments
Assignees

Comments

@grst
Copy link
Collaborator

grst commented Nov 18, 2024

Migrate internal documentation to Sphinx.

Envisaged structure of the docs

README

  • summary of the features
  • links to relevant sections of the documentation

User Guide

  • Get started: A step-by-step introduction to basic DSO features
  • User guide: Details about principles, features and mechanisms of DSO
    • Template engine: mention plan for custom template libraries
    • Config files
    • get-config
    • integration with pre-commit
    • linting
    • integration with uv
    • Integration with DVC (link to relevant DVC docs); e.g. how to reference variables from params.yaml.
    • Quarto integration
      • watermarking
      • configuration in params.in.yaml
    • Syncing DVC changes (mention pre-commit integration)
  • Tutorials
    • Converting an existing project into a dso project
    • How to work on an existing dso project
    • <need to figure out if there's anything in addition to "get started" and "user guide" to cover here - more "tutorial" style thant "documentation style">
  • FAQ
  • Glossary

DSO CLI

  • installation: with and without dso-mgr
  • command reference
  • dso configuration: places to configure dso: pyproject.toml, ENV VARS, .dso.json,

DSO Python API

  • Installation -> refer to DSO CLI and mention UV and pyproject.toml.
  • typical usage
  • Python API reference

DSO R API

Link to pkgdown website (Boehringer-Ingelheim/dso-r#28).

  • installation
  • typical usage
  • R API reference
  • Changelog (link)
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

No branches or pull requests

2 participants