diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..c581f6d --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: "source/conf.py" + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "html" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: requirements.txt diff --git a/.yaml b/.yaml new file mode 100644 index 0000000..9423595 --- /dev/null +++ b/.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: source/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/build/html/_sources/technical.txt b/build/html/_sources/technical.txt index 1d378fe..29d109b 100644 --- a/build/html/_sources/technical.txt +++ b/build/html/_sources/technical.txt @@ -15,7 +15,7 @@ delete privileges only (no create table privileges). This “coral” user shou The CORAL modules are heavily data-driven. As a result we have provided an initial “snapshot” of our data which will be inserted when the MySQL tables are created. Most of this data may be edited through the front-end if desired – refer to the user guide for more information. -For data models and the MySQL Workbench file, refer to http://coral-erm.org/documentation +For data models and the MySQL Workbench file, refer to https://coral-erm.org/documentation #### Server-side scripting @@ -134,7 +134,7 @@ suffix Installation can occur in one of two ways – either through the web installation script or manually. Web installation will provide advantages over manual installation because it will check MySQL privileges and PHP version. -When you first [download the scripts](http://coral-erm.org/download), it is recommended to place each one into a parent `/coral/` directory if your server is sharing space with other applications. This is optional but it helps group all of the coral applications together. +When you first [download the scripts](https://coral-erm.org/download), it is recommended to place each one into a parent `/coral/` directory if your server is sharing space with other applications. This is optional but it helps group all of the coral applications together. For example you may have: ``` @@ -315,7 +315,7 @@ where they appear but leave the format alone. ### Upgrades Upgrades to CORAL will be announced through the CORAL ERM Listserv. If you wish to be added, please -consult http://coral-erm.org or email coral-admin@listserv.nd.edu directly. +consult https://coral-erm.org or email coral-admin@listserv.nd.edu directly. In general, small upgrades with simple coding changes will not be given their own version numbers. If an institution notifies us about a bug we will let them know directly when the bug fix is available. diff --git a/build/html/index.html b/build/html/index.html index 878b6a0..9afa507 100644 --- a/build/html/index.html +++ b/build/html/index.html @@ -6,7 +6,7 @@
-