Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • S Slicer
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 40
    • Merge requests 40
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Artifacts
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Sam Horvath
  • Slicer
  • Merge requests
  • !686

ENH: User and developer guide as RestructuredText **WIP**

  • Review changes

  • Download
  • Patches
  • Plain diff
Open Sam Horvath requested to merge rst-user-and-dev-guide into master Mar 21, 2017
  • Overview 44
  • Commits 29
  • Pipelines 0
  • Changes 58

Created by: jcfr

This is a first draft of the user and developer documentation rendered on http://slicer.readthedocs.io

Documentations is organized in two directories

  • Docs/user_guide
  • Docs/developer_guide

For now, readthedocs will automatically regenerate the documentation each time the branch Slicer/Slicer@rst-user-and-dev-guide is updated.

Configuration files is Docs/conf.py.

After running:

cd Slicer
pip install -r requirements-dcos.txt

on either Windows or Unix, it can locally be generated running:

cd Docs
make html

Notes

  • Consider both installing the requirement and running make html from a virtual environment.

  • I think sections like News, Image Gallery, Tutorials, Slicer Community, Labs, Developer Hangout, FAQs should probably remain on the wiki.

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: rst-user-and-dev-guide