Skip to content

fivethreeo/cocalc-doc

 
 

Repository files navigation

CoCalc User Manual

This is a documentation of CoCalc's features for users. It covers topics like teaching, editing LaTeX documents, calculating with Jupyter Notebooks and Sage Worksheets, etc.

Development

Build Status

Note: the Makefile configures sphinx to throw warnings as errors. Hence even small details like a broken reference link will cause a failed build.

Prerequisites

Build

  • In the root directory, run make html
  • Before submitting a PR, make sure it works by cleaning up first: make clean
  • With inotifywait installed, make watch should automatically build the html files upon changes.

Legal

  • License: CC BY 4.0

  • "CoCalc" is a registered trademark. Usage of the term "CoCalc" refers to the online service CoCalc hosted at https://cocalc.com only.

Releases

No releases published

Packages

No packages published

Languages

  • Python 50.5%
  • HTML 19.6%
  • TeX 13.0%
  • CSS 8.4%
  • Makefile 4.0%
  • Batchfile 3.8%
  • JavaScript 0.7%