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

Revamp docs #233

Merged
merged 70 commits into from
May 11, 2023
Merged

Revamp docs #233

merged 70 commits into from
May 11, 2023

Conversation

thomaspinder
Copy link
Collaborator

This PR provides a major update to the docs. Changes include moving the backend to MKDocs, updating docstrings, and splitting out notebooks.

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

The current docs are outdated.

@thomaspinder thomaspinder added the documentation Improvements or additions to documentation label Apr 22, 2023
@thomaspinder thomaspinder added this to the v0.6 milestone Apr 22, 2023
@thomaspinder thomaspinder self-assigned this Apr 22, 2023
gen_pages.py Outdated Show resolved Hide resolved
Comment on lines +22 to +43
from gpjax.kernels import (
RBF,
RFF,
AbstractKernel,
BasisFunctionComputation,
ConstantDiagonalKernelComputation,
DenseKernelComputation,
DiagonalKernelComputation,
EigenKernelComputation,
GraphKernel,
Linear,
Matern12,
Matern32,
Matern52,
Periodic,
Polynomial,
PoweredExponential,
ProductKernel,
RationalQuadratic,
SumKernel,
White,
)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm assuming this is some kind of auto-expander? this is one of those rare cases where I'd prefer the import * syntax...

gpjax/base/module.py Outdated Show resolved Hide resolved
docs/examples/README.md Outdated Show resolved Hide resolved
docs/index copy.md Outdated Show resolved Hide resolved
gpjax/gps.py Outdated Show resolved Hide resolved
thomaspinder and others added 9 commits May 10, 2023 18:59
Co-authored-by: st-- <st--@users.noreply.github.com>
Signed-off-by: Thomas Pinder <tompinder@live.co.uk>
Co-authored-by: st-- <st--@users.noreply.github.com>
Signed-off-by: Thomas Pinder <tompinder@live.co.uk>
@thomaspinder thomaspinder merged commit 17d3f96 into v0.6 May 11, 2023
11 checks passed
@thomaspinder thomaspinder deleted the docs_update branch May 11, 2023 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants