Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
89 commits
Select commit Hold shift + click to select a range
fde4a53
feat: migrate documentation to Read the Docs
aditigopalan Jan 6, 2026
a170edd
fix: add requirements.txt for Read the Docs to ensure mkdocs-material…
aditigopalan Jan 6, 2026
a3fc5b5
docs: completely redesign documentation structure
aditigopalan Jan 6, 2026
fb5deda
docs: completely rebuild documentation using LinkML gen-doc
aditigopalan Jan 6, 2026
009ea43
docs: simplify to just show schema attribute lists
aditigopalan Jan 6, 2026
e9e3724
docs: add CSS to fix huge icons and tiny text in generated docs
aditigopalan Jan 6, 2026
82a7f94
docs: completely rebuild from scratch - simple clean structure
aditigopalan Jan 6, 2026
cef0108
docs: use simple attribute list format - no LinkML gen-doc
aditigopalan Jan 6, 2026
36d6318
docs: add index.md for simple docs structure
aditigopalan Jan 6, 2026
b7b9c2f
Switch from MkDocs to Sphinx for Read the Docs
aditigopalan Jan 6, 2026
bca8593
Add README content to module docs and improve index structure
aditigopalan Jan 6, 2026
4139070
Add generated module documentation with README content
aditigopalan Jan 6, 2026
3b2c68d
Add table format for attributes with inline enums for short lists
aditigopalan Jan 6, 2026
772e30a
Load enums from imported files and show inline for short enums
aditigopalan Jan 6, 2026
f2a99b8
Fix enum detection to properly show inline values or links
aditigopalan Jan 6, 2026
a5a038f
Properly merge enums from imported files
aditigopalan Jan 6, 2026
9293e69
Fix enum iteration error and show enum links/values in tables
aditigopalan Jan 6, 2026
5ef44e8
Restructure docs: Clinical by class, WES by level, tables only
aditigopalan Jan 6, 2026
1b8cbe7
Clinical: Rename to Manifests, add conditional requirements, clean en…
aditigopalan Jan 7, 2026
82fb28f
Clinical: Use 'Required IF' for conditionals, add Common Attributes s…
aditigopalan Jan 7, 2026
26fd934
Fix pattern extraction and improve conditional requirement clarity
aditigopalan Jan 7, 2026
ed79740
Fix pattern extraction for all attributes and improve conditional req…
aditigopalan Jan 7, 2026
f36cf40
Improve conditional requirement clarity and ensure patterns are captu…
aditigopalan Jan 7, 2026
8488069
Further improve conditional requirement clarity
aditigopalan Jan 7, 2026
c866e05
Remove Pattern column, show patterns in Type column instead
aditigopalan Jan 7, 2026
9f1caad
Escape pipe characters in patterns to prevent markdown table breakage
aditigopalan Jan 7, 2026
a828ef1
Add home page with architecture overview from README
aditigopalan Jan 7, 2026
4146a60
Add image path to Sphinx configuration
aditigopalan Jan 7, 2026
752a623
Escape backticks in patterns to fix markdown table rendering
aditigopalan Jan 7, 2026
8d72ce9
Use HTML code tags instead of backticks for patterns in markdown tables
aditigopalan Jan 7, 2026
94da862
Implement Option B: self-contained module pages with all inherited at…
aditigopalan Jan 7, 2026
6108ded
Fix documentation issues: remove duplicate Enums, add identifier page…
aditigopalan Jan 7, 2026
7e0d995
Refactor generate_class_table to use write_attribute_row for consiste…
aditigopalan Jan 7, 2026
5b8a2db
Add HTAN Centers RFC statement and Curator link to index page, add in…
aditigopalan Jan 7, 2026
2bbdc2e
Remove Data Model Architecture section and image, clean up Contents/R…
aditigopalan Jan 7, 2026
7712535
Restructure docs: remove Classes/Enums headings, create landing pages…
aditigopalan Jan 7, 2026
a8d290f
Add README overview to scRNA-seq landing page
aditigopalan Jan 7, 2026
c9feeb6
Fix level page links by using toctree instead of :doc: directive
aditigopalan Jan 7, 2026
122da32
Fix SpatialOmics schema name check and MultiplexMicroscopy links
aditigopalan Jan 7, 2026
af2e8f4
Fix level page links to use markdown links instead of toctree
aditigopalan Jan 7, 2026
46429a8
Fix level pages: add Core File attributes and use toctree for sidebar…
aditigopalan Jan 7, 2026
d74bdf8
Add level pages to sidebar menu in index.rst
aditigopalan Jan 7, 2026
82d7ec2
Use MyST toctree syntax for nested level pages in sidebar
aditigopalan Jan 7, 2026
f89ca14
Remove unused docs/index.md file
aditigopalan Jan 7, 2026
00834fb
Remove Modules section and Reference caption from index.rst
aditigopalan Jan 7, 2026
1324b20
Add Modules section back to index.rst
aditigopalan Jan 7, 2026
3d49801
Adjust toctree maxdepth values in index.rst
aditigopalan Jan 7, 2026
a719d55
Fix DigitalPathology module, add submission guidance to level pages, …
aditigopalan Jan 7, 2026
ce0acb2
Fix enum anchor links to use full enum name (tumorgradeenum instead o…
aditigopalan Jan 7, 2026
a9020d2
Remove explicit anchor syntax from enum headings and fix enum links t…
aditigopalan Jan 7, 2026
877b4e7
Fix enum links to use simple anchor format matching MyST auto-generat…
aditigopalan Jan 7, 2026
08948de
Add enum sections to level pages (WES, scRNA-seq, etc.) and ensure en…
aditigopalan Jan 7, 2026
fced0af
Remove identifiers page entirely
aditigopalan Jan 7, 2026
81845d7
Add custom CSS to increase documentation content width
aditigopalan Jan 7, 2026
ec67206
Fix content width: use RTD theme option and improved CSS selectors
aditigopalan Jan 7, 2026
3ad0914
Add CSV export functionality for all modules and levels
aditigopalan Jan 7, 2026
9566e91
Fix CSV generation: include all attributes from all classes for Clini…
aditigopalan Jan 7, 2026
89efb9c
Fix FileFormatLevel4 enum: preserve child attributes over parent attr…
aditigopalan Jan 15, 2026
b39eef2
Remove pattern constraint from FILENAME attribute
aditigopalan Jan 15, 2026
b33b755
Remove unused documentation files (identifiers, corefile, imaging, se…
aditigopalan Jan 15, 2026
66d5c5f
Clean up - removing unwanted files
aditigopalan Jan 15, 2026
3f303d8
docs: updating biospecimen readme
aditigopalan Jan 15, 2026
bfa7e72
Remove cruft template tracking (unused)
aditigopalan Jan 15, 2026
821a7c9
Merge bfa7e729e6b60baef22f68c9cdcbc5c75f7e1ff3 into 82823eb9a4429cf9f…
aditigopalan Jan 15, 2026
a5ade02
chore: auto-generate Python classes from schema changes
actions-user Jan 15, 2026
ff99689
Update documentation and tests: remove FILENAME pattern constraint
aditigopalan Jan 15, 2026
2ec3da2
Merge branch 'docs' of https://github.com/ncihtan/htan-linkml into docs
aditigopalan Jan 15, 2026
408ef11
Merge 2ec3da22eb79c1dd2c6b3630ce65e151a13dbd2c into 82823eb9a4429cf9f…
aditigopalan Jan 15, 2026
7547969
chore: auto-generate Python classes from schema changes
actions-user Jan 15, 2026
d7faf39
Add FILENAME pattern constraints matching FILE_FORMAT restrictions
aditigopalan Jan 15, 2026
634cab5
Regenerate documentation with FILENAME pattern constraints
aditigopalan Jan 15, 2026
60dd5ae
Add FILE_FORMAT and FILENAME pattern constraints for WES modules
aditigopalan Jan 15, 2026
cc9fda7
Add FILE_FORMAT and FILENAME pattern constraints for scRNA-seq level …
aditigopalan Jan 15, 2026
b24cf65
Update tests and CSV docs for FILE_FORMAT and FILENAME pattern valida…
aditigopalan Jan 15, 2026
e097bf6
Fix test_level3_class to properly check inherited FILENAME required flag
aditigopalan Jan 15, 2026
2f308a1
Merge e097bf6b6ab7fe36333cf02f15c67471f58a90b2 into 82823eb9a4429cf9f…
aditigopalan Jan 15, 2026
b7b8bfb
chore: auto-generate Python classes from schema changes
actions-user Jan 15, 2026
93e248e
fix: configure Sphinx to output to READTHEDOCS_OUTPUT/html
aditigopalan Jan 15, 2026
4b6338e
Merge 93e248e031428d646a9ff00b577d58c532941da6 into 82823eb9a4429cf9f…
aditigopalan Jan 15, 2026
fa7d1ca
chore: auto-generate Python classes from schema changes
actions-user Jan 15, 2026
31aefc1
fix: use python -m sphinx instead of sphinx-build command
aditigopalan Jan 15, 2026
51b80ad
Merge 31aefc18c939f6f48843f1f79a123550f86f853e into 82823eb9a4429cf9f…
aditigopalan Jan 15, 2026
6540b56
chore: auto-generate Python classes from schema changes
actions-user Jan 15, 2026
fdaa2c7
fix: install requirements in build commands before running sphinx
aditigopalan Jan 15, 2026
44aa99a
Merge fdaa2c725ccbfea0689604777f143131c7486039 into 82823eb9a4429cf9f…
aditigopalan Jan 15, 2026
0c33665
chore: auto-generate Python classes from schema changes
actions-user Jan 15, 2026
50c676f
fix: clean build directories and explicitly set doctrees path
aditigopalan Jan 15, 2026
307d896
Merge 50c676f1bd2568e08067e4fbd1c814a5adeb9b40 into 82823eb9a4429cf9f…
aditigopalan Jan 15, 2026
7b4b201
chore: auto-generate Python classes from schema changes
actions-user Jan 15, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions .cruft.json

This file was deleted.

167 changes: 0 additions & 167 deletions .github/workflows/deploy-docs.yaml

This file was deleted.

9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,15 @@ docs/*
!docs/development.md
!docs/quickstart.md
!docs/index.md
# Allow generated documentation files
!docs/*.md
!docs/**/*.md
# Allow subdirectories with markdown files
!docs/*/
!docs/*/*.md
# Allow CSV exports
!docs/csv/
!docs/csv/*.csv
# Also ignore these specific doc directories
docs/_build/
docs/site/
Expand Down
14 changes: 14 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"
commands:
- pip install -r requirements.txt
- rm -rf _build _readthedocs
- python -m sphinx -b html -d "${READTHEDOCS_OUTPUT}/.doctrees" . "${READTHEDOCS_OUTPUT}/html"

python:
install:
- requirements: requirements.txt
20 changes: 3 additions & 17 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -109,17 +109,9 @@ format:
# ---
#
# check we are up to date
check: cruft-check
cruft-check:
cruft check
cruft-diff:
cruft diff
check: update-linkml

update: update-template update-linkml
update-template:
cruft update

# todo: consider pinning to template
update: update-linkml
update-linkml:
poetry add -D linkml@latest

Expand All @@ -130,7 +122,6 @@ create-data-harmonizer:
all: site
site: gen-project gendoc
%.yaml: gen-project
deploy: all mkd-gh-deploy

compile-sheets:
$(RUN) sheets2linkml --gsheet-id $(SHEET_ID) $(SHEET_TABS) > $(SHEET_MODULE_PATH).tmp && mv $(SHEET_MODULE_PATH).tmp $(SHEET_MODULE_PATH)
Expand Down Expand Up @@ -185,18 +176,13 @@ mkd-%:
git-init-add: git-init git-add git-commit git-status
git-init:
git init
git-add: .cruft.json
git-add:
git add .
git-commit:
git commit -m 'chore: make setup was run' -a
git-status:
git status

# only necessary if setting up via cookiecutter
.cruft.json:
echo "creating a stub for .cruft.json. IMPORTANT: setup via cruft not cookiecutter recommended!" ; \
touch $@

check-config:
ifndef LINKML_SCHEMA_NAME
$(error **Project not configured**:\n\n - See '.env.public'\n\n)
Expand Down
4 changes: 4 additions & 0 deletions _build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f51bb1e327b6630e90dc860f99dd7540
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added _build/html/.doctrees/CONTRIBUTING.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/IDENTIFIER_PATTERNS.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/README.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/archive/README.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/docs/biospecimen.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/docs/clinical.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/docs/corefile.doctree
Binary file not shown.
Binary file not shown.
Binary file added _build/html/.doctrees/docs/imaging.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/docs/index.doctree
Binary file not shown.
Binary file not shown.
Binary file added _build/html/.doctrees/docs/scrna-seq.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/docs/sequencing.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/docs/spatialomics.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/docs/wes.doctree
Binary file not shown.
Binary file added _build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file added _build/html/.doctrees/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading