From 70ac23144db7cb7dd581b2bbb61c1887dd07e386 Mon Sep 17 00:00:00 2001 From: Jordan Cook Date: Sun, 6 Nov 2022 20:52:58 -0600 Subject: [PATCH] Move assets under root dir --- .gitignore | 101 ++---------------- Makefile | 6 +- README.md | 4 +- {docs/_static => assets}/fonts.css | 0 {docs/_static => assets}/fonts/AUTHORS.txt | 0 .../fonts/JetBrainsMono-Bold.ttf | Bin .../fonts/JetBrainsMono-BoldItalic.ttf | Bin .../fonts/JetBrainsMono-ExtraBold.ttf | Bin .../fonts/JetBrainsMono-ExtraBoldItalic.ttf | Bin .../fonts/JetBrainsMono-ExtraLight.ttf | Bin .../fonts/JetBrainsMono-ExtraLightItalic.ttf | Bin .../fonts/JetBrainsMono-Italic.ttf | Bin .../fonts/JetBrainsMono-Light.ttf | Bin .../fonts/JetBrainsMono-LightItalic.ttf | Bin .../fonts/JetBrainsMono-Medium.ttf | Bin .../fonts/JetBrainsMono-MediumItalic.ttf | Bin .../fonts/JetBrainsMono-Regular.ttf | Bin .../fonts/JetBrainsMono-SemiBold.ttf | Bin .../fonts/JetBrainsMono-SemiBoldItalic.ttf | Bin .../fonts/JetBrainsMono-Thin.ttf | Bin .../fonts/JetBrainsMono-ThinItalic.ttf | Bin .../fonts/JetBrainsMonoNL-Bold.ttf | Bin .../fonts/JetBrainsMonoNL-BoldItalic.ttf | Bin .../fonts/JetBrainsMonoNL-ExtraBold.ttf | Bin .../fonts/JetBrainsMonoNL-ExtraBoldItalic.ttf | Bin .../fonts/JetBrainsMonoNL-ExtraLight.ttf | Bin .../JetBrainsMonoNL-ExtraLightItalic.ttf | Bin .../fonts/JetBrainsMonoNL-Italic.ttf | Bin .../fonts/JetBrainsMonoNL-Light.ttf | Bin .../fonts/JetBrainsMonoNL-LightItalic.ttf | Bin .../fonts/JetBrainsMonoNL-Medium.ttf | Bin .../fonts/JetBrainsMonoNL-MediumItalic.ttf | Bin .../fonts/JetBrainsMonoNL-Regular.ttf | Bin .../fonts/JetBrainsMonoNL-SemiBold.ttf | Bin .../fonts/JetBrainsMonoNL-SemiBoldItalic.ttf | Bin .../fonts/JetBrainsMonoNL-Thin.ttf | Bin .../fonts/JetBrainsMonoNL-ThinItalic.ttf | Bin {docs/_static => assets}/fonts/OFL.txt | 0 {docs/_static => assets}/logo.png | Bin {docs/_static => assets}/style.css | 0 {docs => pages}/conf.py | 16 ++- {docs => pages}/index.md | 0 {docs => pages}/subpage_1.md | 0 {docs => pages}/subpage_2.md | 0 44 files changed, 23 insertions(+), 104 deletions(-) rename {docs/_static => assets}/fonts.css (100%) rename {docs/_static => assets}/fonts/AUTHORS.txt (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-Bold.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-BoldItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-ExtraBold.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-ExtraBoldItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-ExtraLight.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-ExtraLightItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-Italic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-Light.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-LightItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-Medium.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-MediumItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-Regular.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-SemiBold.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-SemiBoldItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-Thin.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMono-ThinItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-Bold.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-BoldItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-ExtraBold.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-ExtraBoldItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-ExtraLight.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-ExtraLightItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-Italic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-Light.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-LightItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-Medium.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-MediumItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-Regular.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-SemiBold.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-SemiBoldItalic.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-Thin.ttf (100%) rename {docs/_static => assets}/fonts/JetBrainsMonoNL-ThinItalic.ttf (100%) rename {docs/_static => assets}/fonts/OFL.txt (100%) rename {docs/_static => assets}/logo.png (100%) rename {docs/_static => assets}/style.css (100%) rename {docs => pages}/conf.py (83%) rename {docs => pages}/index.md (100%) rename {docs => pages}/subpage_1.md (100%) rename {docs => pages}/subpage_2.md (100%) diff --git a/.gitignore b/.gitignore index 7e218d5..0ad7f6e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,95 +1,16 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] *$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -pip-wheel-metadata/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* +*.py[cod] .cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.mypy_cache/ -.pytest_cache/ -test-reports/ - -# Translations -*.mo -*.pot - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -.python-version - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Editors -.~* .idea/ +.mypy_cache/ +.nox/ +.pytest_cache/ +.venv .vim/ .vscode/ - -# Sphinx -docs/_build/ -docs/modules/ +.~* +__pycache__/ +_build/ +dist/ +downloads/ +test-reports/ diff --git a/Makefile b/Makefile index 59fa8f4..a5ddf7a 100644 --- a/Makefile +++ b/Makefile @@ -1,12 +1,12 @@ .PHONY: clean docs livedocs clean: - rm -rf docs/_build + rm -rf _build docs: - sphinx-build docs docs/_build/html + sphinx-build pages _build/html livedocs: - sphinx-autobuild docs docs/_build/html -a \ + sphinx-autobuild pages _build/html -a \ --ignore '*.tmp' \ --port 8181 diff --git a/README.md b/README.md index 59a4094..856ad8d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# Test -Placeholder Sphinx doc outline +# jwcook's tilde.team page +Markdown-based static site generated with Sphinx and MyST Prerequisites: * python 3.8+ diff --git a/docs/_static/fonts.css b/assets/fonts.css similarity index 100% rename from docs/_static/fonts.css rename to assets/fonts.css diff --git a/docs/_static/fonts/AUTHORS.txt b/assets/fonts/AUTHORS.txt similarity index 100% rename from docs/_static/fonts/AUTHORS.txt rename to assets/fonts/AUTHORS.txt diff --git a/docs/_static/fonts/JetBrainsMono-Bold.ttf b/assets/fonts/JetBrainsMono-Bold.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-Bold.ttf rename to assets/fonts/JetBrainsMono-Bold.ttf diff --git a/docs/_static/fonts/JetBrainsMono-BoldItalic.ttf b/assets/fonts/JetBrainsMono-BoldItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-BoldItalic.ttf rename to assets/fonts/JetBrainsMono-BoldItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMono-ExtraBold.ttf b/assets/fonts/JetBrainsMono-ExtraBold.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-ExtraBold.ttf rename to assets/fonts/JetBrainsMono-ExtraBold.ttf diff --git a/docs/_static/fonts/JetBrainsMono-ExtraBoldItalic.ttf b/assets/fonts/JetBrainsMono-ExtraBoldItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-ExtraBoldItalic.ttf rename to assets/fonts/JetBrainsMono-ExtraBoldItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMono-ExtraLight.ttf b/assets/fonts/JetBrainsMono-ExtraLight.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-ExtraLight.ttf rename to assets/fonts/JetBrainsMono-ExtraLight.ttf diff --git a/docs/_static/fonts/JetBrainsMono-ExtraLightItalic.ttf b/assets/fonts/JetBrainsMono-ExtraLightItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-ExtraLightItalic.ttf rename to assets/fonts/JetBrainsMono-ExtraLightItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMono-Italic.ttf b/assets/fonts/JetBrainsMono-Italic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-Italic.ttf rename to assets/fonts/JetBrainsMono-Italic.ttf diff --git a/docs/_static/fonts/JetBrainsMono-Light.ttf b/assets/fonts/JetBrainsMono-Light.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-Light.ttf rename to assets/fonts/JetBrainsMono-Light.ttf diff --git a/docs/_static/fonts/JetBrainsMono-LightItalic.ttf b/assets/fonts/JetBrainsMono-LightItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-LightItalic.ttf rename to assets/fonts/JetBrainsMono-LightItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMono-Medium.ttf b/assets/fonts/JetBrainsMono-Medium.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-Medium.ttf rename to assets/fonts/JetBrainsMono-Medium.ttf diff --git a/docs/_static/fonts/JetBrainsMono-MediumItalic.ttf b/assets/fonts/JetBrainsMono-MediumItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-MediumItalic.ttf rename to assets/fonts/JetBrainsMono-MediumItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMono-Regular.ttf b/assets/fonts/JetBrainsMono-Regular.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-Regular.ttf rename to assets/fonts/JetBrainsMono-Regular.ttf diff --git a/docs/_static/fonts/JetBrainsMono-SemiBold.ttf b/assets/fonts/JetBrainsMono-SemiBold.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-SemiBold.ttf rename to assets/fonts/JetBrainsMono-SemiBold.ttf diff --git a/docs/_static/fonts/JetBrainsMono-SemiBoldItalic.ttf b/assets/fonts/JetBrainsMono-SemiBoldItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-SemiBoldItalic.ttf rename to assets/fonts/JetBrainsMono-SemiBoldItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMono-Thin.ttf b/assets/fonts/JetBrainsMono-Thin.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-Thin.ttf rename to assets/fonts/JetBrainsMono-Thin.ttf diff --git a/docs/_static/fonts/JetBrainsMono-ThinItalic.ttf b/assets/fonts/JetBrainsMono-ThinItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMono-ThinItalic.ttf rename to assets/fonts/JetBrainsMono-ThinItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-Bold.ttf b/assets/fonts/JetBrainsMonoNL-Bold.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-Bold.ttf rename to assets/fonts/JetBrainsMonoNL-Bold.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-BoldItalic.ttf b/assets/fonts/JetBrainsMonoNL-BoldItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-BoldItalic.ttf rename to assets/fonts/JetBrainsMonoNL-BoldItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-ExtraBold.ttf b/assets/fonts/JetBrainsMonoNL-ExtraBold.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-ExtraBold.ttf rename to assets/fonts/JetBrainsMonoNL-ExtraBold.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-ExtraBoldItalic.ttf b/assets/fonts/JetBrainsMonoNL-ExtraBoldItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-ExtraBoldItalic.ttf rename to assets/fonts/JetBrainsMonoNL-ExtraBoldItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-ExtraLight.ttf b/assets/fonts/JetBrainsMonoNL-ExtraLight.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-ExtraLight.ttf rename to assets/fonts/JetBrainsMonoNL-ExtraLight.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-ExtraLightItalic.ttf b/assets/fonts/JetBrainsMonoNL-ExtraLightItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-ExtraLightItalic.ttf rename to assets/fonts/JetBrainsMonoNL-ExtraLightItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-Italic.ttf b/assets/fonts/JetBrainsMonoNL-Italic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-Italic.ttf rename to assets/fonts/JetBrainsMonoNL-Italic.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-Light.ttf b/assets/fonts/JetBrainsMonoNL-Light.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-Light.ttf rename to assets/fonts/JetBrainsMonoNL-Light.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-LightItalic.ttf b/assets/fonts/JetBrainsMonoNL-LightItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-LightItalic.ttf rename to assets/fonts/JetBrainsMonoNL-LightItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-Medium.ttf b/assets/fonts/JetBrainsMonoNL-Medium.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-Medium.ttf rename to assets/fonts/JetBrainsMonoNL-Medium.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-MediumItalic.ttf b/assets/fonts/JetBrainsMonoNL-MediumItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-MediumItalic.ttf rename to assets/fonts/JetBrainsMonoNL-MediumItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-Regular.ttf b/assets/fonts/JetBrainsMonoNL-Regular.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-Regular.ttf rename to assets/fonts/JetBrainsMonoNL-Regular.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-SemiBold.ttf b/assets/fonts/JetBrainsMonoNL-SemiBold.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-SemiBold.ttf rename to assets/fonts/JetBrainsMonoNL-SemiBold.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-SemiBoldItalic.ttf b/assets/fonts/JetBrainsMonoNL-SemiBoldItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-SemiBoldItalic.ttf rename to assets/fonts/JetBrainsMonoNL-SemiBoldItalic.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-Thin.ttf b/assets/fonts/JetBrainsMonoNL-Thin.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-Thin.ttf rename to assets/fonts/JetBrainsMonoNL-Thin.ttf diff --git a/docs/_static/fonts/JetBrainsMonoNL-ThinItalic.ttf b/assets/fonts/JetBrainsMonoNL-ThinItalic.ttf similarity index 100% rename from docs/_static/fonts/JetBrainsMonoNL-ThinItalic.ttf rename to assets/fonts/JetBrainsMonoNL-ThinItalic.ttf diff --git a/docs/_static/fonts/OFL.txt b/assets/fonts/OFL.txt similarity index 100% rename from docs/_static/fonts/OFL.txt rename to assets/fonts/OFL.txt diff --git a/docs/_static/logo.png b/assets/logo.png similarity index 100% rename from docs/_static/logo.png rename to assets/logo.png diff --git a/docs/_static/style.css b/assets/style.css similarity index 100% rename from docs/_static/style.css rename to assets/style.css diff --git a/docs/conf.py b/pages/conf.py similarity index 83% rename from docs/conf.py rename to pages/conf.py index 4e96c2d..4ed6d5c 100644 --- a/docs/conf.py +++ b/pages/conf.py @@ -8,8 +8,8 @@ needs_sphinx = '4.0' master_doc = 'index' source_suffix = ['.md', '.rst'] version = release = '0.0.1' -html_static_path = ['_static'] -exclude_patterns = ['_build'] +html_static_path = ['../assets'] +exclude_patterns = ['_build', 'README.md'] templates_path = ['_templates'] # Sphinx extensions @@ -31,22 +31,20 @@ myst_enable_extensions = [ ] # HTML general settings -# html_favicon = join('_static', 'favicon.ico') +# html_favicon = join('../assets', 'favicon.ico') html_css_files = [ 'fonts.css', 'style.css', 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css', ] html_title = 'jwcook\'s home page' -# html_logo = '_static/logo.png' +# html_logo = '../assets/logo.png' html_show_copyright = False html_show_sphinx = False -# notfound_default_version = 'stable' +# HTML theme settings pygments_style = 'gruvbox-light' pygments_dark_style = 'gruvbox-dark' - -# HTML theme settings html_theme = 'furo' html_theme_options = { # 'light_logo': 'logo-light.webp', @@ -55,11 +53,11 @@ html_theme_options = { 'light_css_variables': { 'font-stack': 'JetBrainsMono', 'color-brand-primary': '#b57614', - 'color-brand-content': '#79740e', + 'color-brand-content': '#076678', }, 'dark_css_variables': { 'font-stack': 'JetBrainsMono', 'color-brand-primary': '#fabd2f', - 'color-brand-content': '#b8bb26', + 'color-brand-content': '#83a598', }, } diff --git a/docs/index.md b/pages/index.md similarity index 100% rename from docs/index.md rename to pages/index.md diff --git a/docs/subpage_1.md b/pages/subpage_1.md similarity index 100% rename from docs/subpage_1.md rename to pages/subpage_1.md diff --git a/docs/subpage_2.md b/pages/subpage_2.md similarity index 100% rename from docs/subpage_2.md rename to pages/subpage_2.md