Skip to content

Commit 49d6874

Browse files
dweindldweindl
authored
Move documentation -> doc (#2656)
* Use more canonical name documentation/ -> doc/ * Build doxygen documentation under doc/build_doxygen/ instead of doc/ * Make Doxyfile compatible with recent doxygen
1 parent a69acc5 commit 49d6874

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+40
-56
lines changed

‎.readthedocs.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ version: 2
88
# Build documentation in the docs/ directory with Sphinx
99
sphinx:
1010
builder: html
11-
configuration: documentation/conf.py
11+
configuration: doc/conf.py
1212
fail_on_warning: True
1313

1414
formats:
1515
- pdf
1616

1717
python:
1818
install:
19-
- requirements: documentation/rtd_requirements.txt
19+
- requirements: doc/rtd_requirements.txt
2020
build:
2121
os: "ubuntu-22.04"
2222
apt_packages:

‎README.md‎

Lines changed: 7 additions & 7 deletions

‎binder/overview.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"source": [
99
"# AMICI example notebooks\n",
1010
"\n",
11-
"* [Getting started](../documentation/GettingStarted.ipynb)\n",
11+
"* [Getting started](../doc/GettingStarted.ipynb)\n",
1212
"\n",
1313
" Brief intro to AMICI for first-time users.\n",
1414
"\n",

documentation/CI.md renamed to doc/CI.md

documentation/CODE_OF_CONDUCT.md renamed to doc/CODE_OF_CONDUCT.md

documentation/CONTRIBUTING.md renamed to doc/CONTRIBUTING.md

documentation/CPP.rst renamed to doc/CPP.rst

documentation/CPP_.md renamed to doc/CPP_.md

documentation/ExampleEquilibrationLogic.ipynb renamed to doc/ExampleEquilibrationLogic.ipynb

File renamed without changes.

documentation/ExampleExperimentalConditions.ipynb renamed to doc/ExampleExperimentalConditions.ipynb

File renamed without changes.

0 commit comments

Comments
 (0)