-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Readthedocs #25
Merged
Merged
Readthedocs #25
Changes from all commits
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
96c4e32
First commit with template
justin13601 0ca75ce
Update docs configs
justin13601 0a22e27
Docs requirements
justin13601 70760b8
Requirements
justin13601 0be1790
Requirements
justin13601 82acee3
Requirements
justin13601 0841b53
Requirements
justin13601 d6e0e74
Using website demo
justin13601 baf2916
path typo
justin13601 83930b2
Update configs
justin13601 97d3bd7
Fail on warning false for now
justin13601 791c8d7
Requirements
justin13601 949b1b8
ESGPT partial config test
justin13601 049f89d
Remove bibtex
justin13601 20db507
Project specifics
justin13601 a0f44fe
pypandoc
justin13601 955e57a
V1
justin13601 517e965
Remove pdf
justin13601 b55bbad
Logo
justin13601 3f8e514
Colours
justin13601 dbb72d1
API
justin13601 e11d5a8
API reference and other pages
justin13601 e17b676
Requirements
justin13601 f1c18b1
Remove linkify
justin13601 2440034
Linkify dependency
justin13601 0d17272
Overview title
justin13601 d685d58
Customizations
justin13601 ff37095
Tutorial page
justin13601 1d3b366
Colors
justin13601 405fd24
Colours
justin13601 d34193b
Colours
justin13601 1eb9439
Change to terminology
justin13601 37469c3
Update docs
justin13601 35274c3
Doc changes
justin13601 385441e
Formatting
justin13601 3fa049a
Undo html
justin13601 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# .readthedocs.yaml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the version of Python and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.10" | ||
|
||
python: | ||
install: | ||
- requirements: docs/requirements.txt | ||
- method: pip | ||
path: . | ||
extra_requirements: | ||
- docs | ||
# Build documentation in the docs/ directory with Sphinx | ||
sphinx: | ||
configuration: docs/source/conf.py | ||
# fail_on_warning: true | ||
# Optionally build your docs in additional formats such as PDF | ||
# formats: | ||
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,4 +1,4 @@ | ||||||
# ESGPT Task Querying - Coming Soon... | ||||||
# ESGPTTaskQuerying | ||||||
|
||||||
![](https://img.shields.io/badge/python-3.10-blue) | ||||||
|
||||||
|
@@ -16,7 +16,7 @@ This README provides an overview of this feature, including a description of the | |||||
|
||||||
Provided below are several examples of clinically-meaningful tasks that ESGPT Task Querying could easily extract subject cohorts for: | ||||||
|
||||||
![Task Schema Definition](./TaskSchemaDefinition.svg) | ||||||
![Task Schema Definition](ESGPTTaskQuerying/TaskSchemaDefinition.svg) | ||||||
|
||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider adding alt text to the image for better accessibility. - ![Task Schema Definition](ESGPTTaskQuerying/TaskSchemaDefinition.svg)
+ ![Diagram of Task Schema Definition](ESGPTTaskQuerying/TaskSchemaDefinition.svg) Committable suggestion
Suggested change
|
||||||
## Dependencies | ||||||
|
||||||
|
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,20 @@ | ||
# Minimal makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line, and also | ||
# from the environment for the first two. | ||
SPHINXOPTS ?= | ||
SPHINXBUILD ?= sphinx-build | ||
SOURCEDIR = source | ||
BUILDDIR = build | ||
|
||
# Put it first so that "make" without argument is like "make help". | ||
help: | ||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
||
.PHONY: help Makefile | ||
|
||
# Catch-all target: route all unknown targets to Sphinx using the new | ||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
%: Makefile | ||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
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,35 @@ | ||
@ECHO OFF | ||
|
||
pushd %~dp0 | ||
|
||
REM Command file for Sphinx documentation | ||
|
||
if "%SPHINXBUILD%" == "" ( | ||
set SPHINXBUILD=sphinx-build | ||
) | ||
set SOURCEDIR=source | ||
set BUILDDIR=build | ||
|
||
if "%1" == "" goto help | ||
|
||
%SPHINXBUILD% >NUL 2>NUL | ||
if errorlevel 9009 ( | ||
echo. | ||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | ||
echo.installed, then set the SPHINXBUILD environment variable to point | ||
echo.to the full path of the 'sphinx-build' executable. Alternatively you | ||
echo.may add the Sphinx directory to PATH. | ||
echo. | ||
echo.If you don't have Sphinx installed, grab it from | ||
echo.http://sphinx-doc.org/ | ||
exit /b 1 | ||
) | ||
|
||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
goto end | ||
|
||
:help | ||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
|
||
:end | ||
popd |
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,9 @@ | ||
sphinx==7.1.2 | ||
sphinx-rtd-theme==1.3.0rc1 | ||
sphinx-collections | ||
sphinx_immaterial | ||
sphinx_subfigure | ||
nbsphinx | ||
myst_parser | ||
pypandoc | ||
linkify-it-py |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add alternate text to the image for accessibility.
Committable suggestion