Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update documentation styling for easier navigation#624

Merged
tomvothecoder merged 13 commits intomainfrom
doc/618-doc-style
Mar 20, 2024
Merged

Update documentation styling for easier navigation#624
tomvothecoder merged 13 commits intomainfrom
doc/618-doc-style

Conversation

@tomvothecoder
Copy link
Collaborator

@tomvothecoder tomvothecoder commented Mar 18, 2024

Description

Summary of changes

  • Update README.rst contributors section
  • Add sphinx_design dependency for grid tables
  • Update homepage for simple navigation
  • Add overview.rst page to move overview content
  • Add getting-start-guides/ with sub-nesting of pages for getting started
  • Add team.rst with grid of team members
  • Update gallery.rst with grid of examples
  • Update demos.rst with grid of links
  • Update conf.py configuration for sphinx_design grid, custom CSS stylesheet, and custom xarray functions for generating grids
  • Update .gitignore

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

If applicable:

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass with my changes (locally and CI/CD build)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have noted that this is a breaking change for a major release (fix or feature that would cause existing functionality to not work as expected)

- Add sphinx_design for grid tables
- Update homepage for simple navigation
- Add `overview.rst` page to move overview content
- Add `getting-start-guides/` with sub-nesting of pages for getting started
- Add `team.rst` with grid of team members
- Update `gallery.rst` with grid of examples
- Update `conf.py` configuration for `sphinx_design` grid, custom CSS stylesheet, and custom xarray functions for generating grids
- Update `.gitignore`
@github-actions github-actions bot added the type: docs Updates to documentation label Mar 18, 2024
@codecov
Copy link

codecov bot commented Mar 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d0e33aa) to head (28a5af6).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #624   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           15        15           
  Lines         1588      1588           
=========================================
  Hits          1588      1588           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tomvothecoder
Copy link
Collaborator Author

@tomvothecoder tomvothecoder marked this pull request as ready for review March 20, 2024 18:02
@tomvothecoder tomvothecoder merged commit b86f0ce into main Mar 20, 2024
@tomvothecoder tomvothecoder deleted the doc/618-doc-style branch March 20, 2024 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Updates to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

[Doc]: Improve style and navigation of documentation site

1 participant

Comments