Skip to content

Commit

Permalink
DOC: Add Sphinx Documentation rendering
Browse files Browse the repository at this point in the history
This adds Myst (markdown) Sphinx documentation. This is to be rendered on
ReadTheDocs and deployed on docs.itk.org. A start for issue InsightSoftwareConsortium#4063.
Changes and more content are expected in the future! In particular, the
old wiki content, Software Guide content, and Tutorial. It
uses the clean and elegant Furo theme, which works with Myst and is also
used by docs.vtk.org and wasm.itk.org.

This incorporates the markdown files in the Documentation/ directory. It
renders a clean build without warnings. A few changes were required for
to avoid warknings, e.g. header specifications and cross-link
specifications.

Symlinks were created at the top level for CODE_OF_CONDUCT.md and
CONTRIBUTING.md, but these should be replace by real files with links to
the rendered content once published for GitHub access.

Co-authored-by: Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com>
  • Loading branch information
thewtex and jcfr committed Oct 8, 2023
1 parent ecd7bda commit a7a92d4
Show file tree
Hide file tree
Showing 84 changed files with 5,053 additions and 955 deletions.
20 changes: 20 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"
apt_packages:
- fonts-roboto

sphinx:
configuration: Documentation/docs/conf.py

python:
install:
- requirements: Documentation/docs/requirements.txt
434 changes: 0 additions & 434 deletions CODE_OF_CONDUCT.md

This file was deleted.

1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
375 changes: 0 additions & 375 deletions CONTRIBUTING.md

This file was deleted.

0 comments on commit a7a92d4

Please sign in to comment.