Skip to content
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

Enhancements to Documentation Structure and Theme Upgrade #249

Merged
merged 47 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
c23b424
add .DS_Store in gitignore for mac
Fanchengyan Jul 21, 2024
240295b
GitButler Integration Commit
gitbutler-client Jul 21, 2024
fbd0b40
reconstruct doc @ sphinx_rtd_theme->pydata_sphinx_theme
Fanchengyan Jul 21, 2024
eb3d586
refine docs
Fanchengyan Jul 21, 2024
511a570
using logo in doc header
Fanchengyan Jul 21, 2024
40ae3e5
Merge branch 'master' into dev
Fanchengyan Jul 21, 2024
67e1aea
Merge branch 'gitbutler/integration' into dev
Fanchengyan Jul 21, 2024
cc9f408
formated by hook
Fanchengyan Jul 24, 2024
9c617d5
refine docs: add logo in header; emoji title; wider body;
Fanchengyan Jul 24, 2024
058c8de
format by hooks & fix sevel dir bugs
Fanchengyan Jul 24, 2024
1de9e45
fix bugs for pydata-sphinx-theme
Fanchengyan Jul 24, 2024
398787d
add navbar-logo.html to _templates for readthedocs
Fanchengyan Jul 24, 2024
c8cc4e2
update sphinx to 7.4.7 for pydata-theme
Fanchengyan Jul 24, 2024
2ca8dc3
rm generated docs
Fanchengyan Jul 24, 2024
9a03bbd
Fix pytest bug related to document structure modification
Fanchengyan Jul 24, 2024
83edf76
remove unneeded files
Fanchengyan Jul 25, 2024
a849288
remove background color for the shapes-grid & remove logo in home page
Fanchengyan Jul 25, 2024
d7cfd7e
Refactor example section & myst-nb -> nbsphinx for gallery example
Fanchengyan Jul 25, 2024
47d6514
update baseline to pass test
Fanchengyan Jul 26, 2024
a389227
skip test_set_extent_to_location due to nominatim.openstreetmap.org i…
Fanchengyan Jul 26, 2024
ac24fab
add gen_gallery.py for auto gallery | remove nbsphinx
Fanchengyan Aug 5, 2024
47dba5a
fix make html not work in windows | refine doc_env
Fanchengyan Aug 5, 2024
4d92db2
skip running example_webmaps.ipynb
Fanchengyan Aug 5, 2024
325c4cd
change example path in pytest
Fanchengyan Aug 6, 2024
4368159
fix pre-commit
Fanchengyan Aug 7, 2024
43cc572
Merge branch 'dev' into gitbutler/integration
Fanchengyan Aug 10, 2024
9da85f9
update docs: using myst_sphinx_gallery to gen gallery
Fanchengyan Aug 10, 2024
e57954b
update environment.yml
Fanchengyan Aug 16, 2024
ba6dbe1
change myst-sphinx-gallery to conda channel
Fanchengyan Aug 20, 2024
b899eec
custom gallery style: font (black small lighter) & add 10px margin fo…
Fanchengyan Aug 20, 2024
18dfa2f
Merge branch 'gitbutler/integration' of https://github.com/Fanchengya…
Fanchengyan Aug 20, 2024
4565e5b
improve dark mode effect @ remove emojis in header
Fanchengyan Aug 23, 2024
768922c
remove unnecessary dependencies
Fanchengyan Aug 23, 2024
c58a125
back to origin baseline
Fanchengyan Aug 23, 2024
ac35927
Merge branch 'dev' of https://github.com/raphaelquast/EOmaps into git…
Fanchengyan Aug 23, 2024
1c72162
fix sphinx warning "Summarised items should not include the current m…
raphaelquast Aug 24, 2024
616779b
update doc dependencies to most recent versions
raphaelquast Aug 24, 2024
c06165c
fix identification of documentation and example-codeblocks as unittests
raphaelquast Aug 24, 2024
10b9949
address docutils PendingDeprecationWarning
raphaelquast Aug 24, 2024
3b0c672
Shorten section titles to better fit into right sidebar
raphaelquast Aug 24, 2024
843615f
fix autdoc for reader methods
raphaelquast Aug 25, 2024
6aa9f69
hide left sidebars for orphan-pages
raphaelquast Aug 25, 2024
2f14b1f
remove secondary sidebar for galery page
raphaelquast Aug 25, 2024
ddab920
remove primary sidebar on API-reference landing page and add proper h…
raphaelquast Aug 25, 2024
65955c1
re-structure user-gruide landing-page to avoid intermediate pages
raphaelquast Aug 25, 2024
61849fe
use object-name for autodoc to ensure uniform naming in TOC
raphaelquast Aug 25, 2024
f732bf9
add missing user guide sections
raphaelquast Aug 26, 2024
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
12 changes: 8 additions & 4 deletions .gitignore
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ docs/build
docs/_build
docs/debug.log
docs/.vscode
docs/generated
docs/api/autodoc_additional_props.rst
docs/source/generated
docs/source/auto_examples
docs/source/api/autodoc_additional_props.rst

docs/_tables
docs/_static/example_gifs_very_old
docs/source/_tables
docs/source/_static/example_gifs_very_old

logos
tests/Images
Expand All @@ -32,3 +33,6 @@ _exclude*
docs/jupyter_execute/*
docs/.jupyter_cache/*
docs/.virtual_documents/*

# mac
.DS_Store
371 changes: 0 additions & 371 deletions docs/EOmaps_examples.rst

This file was deleted.

Loading
Loading