# cocalc-doc

**Repository Path**: heartk/cocalc-doc

## Basic Information

- **Project Name**: cocalc-doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-15
- **Last Updated**: 2024-01-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 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.

- [CoCalc online service](https://cocalc.com/)
- [CoCalc source code](https://github.com/sagemathinc/cocalc)

## Development

[![Build Status](https://travis-ci.org/sagemathinc/cocalc-doc.svg?branch=master)](https://travis-ci.org/sagemathinc/cocalc-doc)

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

- Sphinx 6.1.3+
- Knowledge about [ReST Doc](http://www.sphinx-doc.org/en/1.8/rest.html)
- [ReST/Sphinx Cheat Sheet](http://docs.sphinxdocs.com/en/latest/cheatsheet.html)

### 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](LICENSE.txt)

- "CoCalc" is a [registered trademark](http://tsdr.uspto.gov/#caseNumber=87155974&caseType=SERIAL_NO&searchType=statusSearch). Usage of the term "CoCalc" refers to the online service CoCalc hosted at `https://cocalc.com` only.