Skip to content

[FEATURE] Documentation update#1250

Draft
davidorme wants to merge 206 commits intodevelopfrom
feature/docs-ui-update
Draft

[FEATURE] Documentation update#1250
davidorme wants to merge 206 commits intodevelopfrom
feature/docs-ui-update

Conversation

@davidorme
Copy link
Copy Markdown
Collaborator

@davidorme davidorme commented Jan 8, 2026

Description

This PR is for the feature/docs-ui-update branch, which is being used to collect changes to the documentation before rolling it out officially to develop. The intention is to stop the main site content (which follows develop) from jigging around all over the place while people are trying to use it and provide a single stable update.

Summary of issues merged in here:

  • Swapping to pydata-sphinx-theme
  • Adding a DataTables version of the variables table: searchable and filterable.
  • Implementation section renamed to Science, and restructured to make it easier to find the scientific content of the models
  • Removed developer focused content out of the Users section (where it just confuses people) into the Developers section
  • Structured the sidebar of the Users documentation pages to highlight the tutorials primarily, with reference materials at the bottom grouped into a couple of subheadings

Important

  • This PR is being built here: https://virtual-ecosystem.readthedocs.io/en/feature-docs-ui-update/
  • This PR branch requires merges to add new content. PRs onto this branch have a reduced set of tests that need to pass (docs, pre-commit, and one test). The branch will need to pass the full suite when we merge into develop, but this reduces the overhead for a PR of largely docs based changes.
    If you are creating a branch on an issue to bring in here remember to change the target branch from develop

Will close #1248

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works
  • Relevant documentation reviewed and updated

@davidorme davidorme linked an issue Jan 8, 2026 that may be closed by this pull request
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 8, 2026

Codecov Report

❌ Patch coverage is 0% with 68 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.10%. Comparing base (2dd731e) to head (7f9193c).

Files with missing lines Patch % Lines
virtual_ecosystem/core/docutils.py 0.00% 68 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1250      +/-   ##
===========================================
- Coverage    94.95%   94.10%   -0.85%     
===========================================
  Files           71       72       +1     
  Lines         7536     7604      +68     
===========================================
  Hits          7156     7156              
- Misses         380      448      +68     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jacobcook1995 jacobcook1995 force-pushed the feature/docs-ui-update branch from 473bb64 to 20985a1 Compare March 18, 2026 14:54
jacobcook1995 and others added 15 commits March 19, 2026 07:37
…hinx-theme-ui-issues

Made dark mode look less awful
…re_branch

Bring docs feature branch up to date with develop
…ls_docs

Plant data preparation details docs
merge develop into `feature/update-docs-ui` (again)
…ures

Merge Vivienne's recent docs changes into documentation improvement branch
…g_hunting_docs

Added basic bug hunting documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[META-META!] Feature branch for docs update

3 participants