-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Initialize documentation (#85)
Start of documentation, mostly copied the core dependencies and plugins from med-imagetools - Set up initial documentation structure using MkDocs, including configuration and integration of Markdown files for the README and CHANGELOG. this "core" would be the base of the main vs 2.0 branch <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Added badges for project health and status in the README. - Expanded installation instructions with a new environment setup method. - Introduced a section for serving documentation locally. - **Documentation** - Enhanced clarity and structure of the README, including command-line options and contributing guidelines. - Updated inclusion method for CHANGELOG and README in documentation. - Introduced a new configuration file for MkDocs documentation, improving navigation and usability. - **Bug Fixes** - Corrected formatting for bash commands in the README to enhance readability. - **Chores** - Updated project version and dependencies in the configuration files. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
- Loading branch information
Showing
6 changed files
with
813 additions
and
450 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,5 @@ | ||
```{include} ../CHANGELOG.md | ||
``` | ||
|
||
{% | ||
include-markdown "../CHANGELOG.md" | ||
rewrite-relative-urls=false | ||
%} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,8 @@ | ||
```{include} ../README.md | ||
``` | ||
# READII (Radiomic Extraction and Analysis for DICOM Images) | ||
|
||
```{toctree} | ||
:maxdepth: 1 | ||
:hidden: | ||
example.ipynb | ||
changelog.md | ||
contributing.md | ||
conduct.md | ||
autoapi/index | ||
``` | ||
{% | ||
include-markdown "../README.md" | ||
start="<!--intro-start-->" | ||
end="<!--intro-end-->" | ||
rewrite-relative-urls=false | ||
%} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
site_name: READII | ||
repo_url: https://github.com/bhklab/readii | ||
repo_name: readii | ||
site_description: Package documentation for readii | ||
site_author: bhklab | ||
|
||
watch: [docs, src, mkdocs.yaml] | ||
# The directory where the documentation files are located | ||
docs_dir: docs | ||
|
||
# The directory where the documentation is built (add to .gitignore if changed) | ||
site_dir: site | ||
|
||
# Set a list of CSS files (relative to docs_dir) to be included by the theme | ||
# typically as <link> tags. | ||
extra_css: [] | ||
|
||
# This is the branch where the documentation will pushed to using | ||
# 'mkdocs gh-deploy' and from where it will be served by GitHub Pages. | ||
remote_branch: gh-pages | ||
|
||
# Address when using 'mkdocs serve', format is 'address:port' | ||
dev_addr: 127.0.0.1:8001 | ||
|
||
# The layout of the navigation links | ||
nav: | ||
- Home: index.md | ||
- Changelog: changelog.md | ||
|
||
plugins: | ||
- awesome-pages # simplifies configuring page titles and their order | ||
- search # necessary for search functionality to work | ||
- git-authors # adds authors to pages using git history | ||
- include-markdown # allows for including Markdown files into another Markdown file | ||
|
||
theme: | ||
name: material | ||
features: | ||
- announce.dismiss | ||
- content.action.edit | ||
- content.action.view | ||
- content.code.annotate | ||
- content.code.copy | ||
- content.tooltips | ||
- navigation.footer | ||
- navigation.indexes | ||
- navigation.sections | ||
- navigation.tabs | ||
- navigation.tabs.sticky | ||
- navigation.top | ||
- search.highlight | ||
- search.suggest | ||
- toc.follow |
Oops, something went wrong.