Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

ENH: Move docs folder to sphinx-docs #768

Merged
merged 26 commits into from
Aug 4, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
3f49383
📝Move docs folder to sphinx-docs
peterhessey Jul 21, 2022
8f8513d
Trigger build for new URL
peterhessey Jul 21, 2022
3390a4a
📝 Fix build to include README + CHANGLOG
peterhessey Jul 22, 2022
6487d06
📝 Add back in link fixing
peterhessey Jul 22, 2022
da3f4de
🐛 Fix docs links
peterhessey Jul 22, 2022
a319eac
🚨 📝 Fix markdown linting
peterhessey Jul 22, 2022
2591db6
📝 Change relative links to GitHub ones permanently
peterhessey Jul 22, 2022
3d201e2
📝 Replace more relative paths
peterhessey Jul 22, 2022
9fc25a9
⚡️ 📝 Switch to symlinks
peterhessey Jul 25, 2022
e8c6852
📝 Replace README in toctree
peterhessey Jul 25, 2022
e2702b5
📝 Update README
peterhessey Jul 26, 2022
46c1966
🐛 Attempt to fix images not rendering
peterhessey Jul 26, 2022
7f2c2e6
🐛 Fix broken links
peterhessey Jul 26, 2022
8156e79
Remove IDE settings from gitignore
peterhessey Jul 27, 2022
678b616
⚡️ Move docs to `docs/` and add Makefile back
peterhessey Jul 27, 2022
33e3a06
🙈 Update gitignore
peterhessey Jul 27, 2022
27e2893
♻️ ⚡️ Resolve review comments and change theme
peterhessey Jul 28, 2022
07ee50e
📝 🔀 Rebase + markdown linting
peterhessey Aug 2, 2022
686ca06
🔥 Remove build files (again)
peterhessey Aug 2, 2022
cc54f15
🙈 Remove pieline-breaking symlink
peterhessey Aug 2, 2022
11ecd1f
➕ Add furo to sphinx dependencies
peterhessey Aug 2, 2022
5353ae3
📌 Move sphinx deps to environment.yml + lock
peterhessey Aug 3, 2022
f5d3f76
📝 Improve doc folder structure
peterhessey Aug 3, 2022
a30f609
Return to copying instead of symlink
peterhessey Aug 3, 2022
5985fda
📝 Update indexing and titles
peterhessey Aug 3, 2022
efc5f9e
📝 Address review comments
peterhessey Aug 3, 2022
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
Prev Previous commit
Next Next commit
📝 Fix build to include README + CHANGLOG
  • Loading branch information
peterhessey committed Aug 2, 2022
commit 3390a4a55d29ad636ad8427d0fa63ea75d209b26
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,10 @@ instance/

# Sphinx documentation
sphinx-docs/build/
sphinx-docs/sphinx-build/
sphinx-docs/source/md/
peterhessey marked this conversation as resolved.
Show resolved Hide resolved
sphinx-docs/source/docs/CHANGELOG.md
peterhessey marked this conversation as resolved.
Show resolved Hide resolved
sphinx-docs/source/docs/README.md

# PyBuilder
target/
Expand Down
12 changes: 12 additions & 0 deletions sphinx-docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
# documentation root, make it absolute.
#
import sys
import shutil
from pathlib import Path
repo_dir = Path(__file__).absolute().parents[2]
sys.path.insert(0, str(repo_dir))
Expand Down Expand Up @@ -84,3 +85,14 @@
'members': True,
'undoc-members': True,
}


# -- Copy markdown files to source directory --------------------------------

sphinx_root = Path(__file__).absolute().parent
repository_root = sphinx_root.parent.parent
repository_url = "https://github.com/microsoft/InnerEye-DeepLearning"

# Copy all markdown files to the markdown directory
shutil.copy(repository_root / "README.md", sphinx_root / "docs")
shutil.copy(repository_root / "CHANGELOG.md", sphinx_root / "docs")