- Fixed building docs at
crate/crate
by removing strayREADME.md
- Furo: Started using vendorized colors to make mixins work
- Furo: Started using non-vendorized head variables
- Templates: Use proper
base.html
and clean uppage.html
- Updated to most recent Furo
- Added dark theme mode from Furo
Thanks, @msbt.
- Re-added menu item about Cloud CLI (croud)
- Webpack: Use legacy configuration options with Sass 16
- Navigation: Brought back ESI
- Chore: Cleaned up styles
- RTD: Add compatibility fixes for upstream changes at Read The Docs, enabling Read the Docs Addons by default.
- RTD: Fix CSS to hide RTD-injected elements: Ads, fly-out, and footer.
- RTD: Vendorize
sphinx-build-compatibility
to permit publishingcrate-docs-theme
to PyPI. - RTD: Fix inquiring active project versions.
The v2 API returns or started returning inactive builds (PR numbers) in
inquiries to active project versions. The v3 API works better, so the
code in
sphinx-build-compatibility
has been adjusted correspondingly. - New GitHub Issues: Make link checker ignore HTML anchor references
on GitHub after switching to the evolved GitHub Issues. This includes an
update to
sphinx>=7.1,<9
, to respect thelinkcheck_anchors_ignore_for_url
configuration setting.
- Added a "Academy" menu item
- Applied spacing to article footer
- Switch to modern responsive 3-column layout theme
sphinx-basic-ng
, spiced by by elements and styles from Furo. Thanks, @pradyunsg.
- Fixed word-breaks in field lists
- CSS: Adjusted inner alignment being off for cards with links
- Home: Added new top-level landing page, indexing the main docs entrypoints
- Updated to
sphinx-design-elements==0.4.0
andsphinx-design==0.6.0
- Removed support for Python 3.7 and 3.8
- Added documentation project
sqlalchemy-cratedb
- Removed separate "Install" menu item
- Fix URLs to GitHub feedback, removed hard-coded
https://cratedb.com/
- Fix downstream behavior on "not versioned" projects like CrateDB Guide.
- Remove Google Search and implement Algolia docsearch
- Remove search.html and genindex.html from site.xml
- Cleanups: Remove configurations for
cloud_{howtos,reference,tutorials}
- Fix computing URLs for rel="canonical"
- Fix compatibility issue with Python 3.8, by updating to sphinx-design-elements 0.3.1
- Fix missing CI colors to align with the main website
- Update icons with the corresponding colors
- Introduce a secondary color for improved accessibility
- Small improvement for the version/feedback dropdown on mobile
- Remove intersphinx mappings to
crate-howtos
andcrate-tutorials
, they have been converged intocratedb-guide
. - Update to sphinx-design-elements 0.3.0
- Replaced
Poppins
font withMontserrat
for H1 - Removed legacy
.woff
font-files - Update SQL-99 config (
html_baseurl
,url_path
andcanonical_url_path
) - Removed
webflow.js
, artifacts from the abandoned feedback box and rating system, removed unused css - Added "Guides and Tutorials" section
- Removed reference to "SQL-99 Complete, Really", and prepare phasing it out from the cratedb.com domain. It will be published to https://sql-99.readthedocs.io/ instead.
- Removed HubSpot CTA from SQL-99 header
- Decluttered/separated SQL-99 footer
- Updated SQL-99 CTAs
- Updated unsplash profile URL to fix 404
- Tracking: Removed Segment and replaced it with Google Tagmanager
- Primary navigation: Use
maxdepth=2
for serving "CrateDB Cloud" That means, only pull headings up to the second level into the menu. Thanks, @proddata. - Search: Added
autofocus
to search input for better usability. Thanks, @msbt.
- Stop displaying the edit/view source link on synthetic pages, for example,
the
search.html
page. Thanks, @msbt. - Changed domain from
crate.io
tocratedb.com
- Add version chooser JavaScript helpers derived from
pydata-sphinx-theme
. Thanks, @drammock.
- Adjust OpenGraph settings: Logo image, description length, "first image" use. Thanks, @proddata and @msbt.
- Improve primary navigation on the database driver section once more
- Fix CSS: Remove font size of blockquote override. Thanks, @msbt.
- Improve version chooser: Remove ambiguous link to root document. Thanks, @hlcianfagna.
- Bring back lost navigation items to database drivers. Thanks, @proddata.
- Fix minor regression on admonitions
- Fix page tools positioning
- Fix margin on page tools element
- Modernize and fix JS and CSS includes
- Fix pagetools dropdown: Group elements to define mutual toggle-opening. Thanks, @kojinkai and @msbt.
- Improve version chooser to use the same page when switching versions. Thanks, @hlcianfagna.
- Fix text alignment with sphinx-togglebutton. Thanks, @msbt.
- Edit primary navigation in left sidebar
- "CrateDB Cloud" documentation has been bundled into a single repository, now
located at
/docs/cloud
- Add link to "Community" and "Integration tutorials"
- Rename
Install CrateDB
toInstall
, andReference
toCrateDB Reference
- Improve appearance of bottom section
- "CrateDB Cloud" documentation has been bundled into a single repository, now
located at
- Consolidated Cloud Docs: Adjust intersphinx root references
- Those project references have been dissolved:
cloud-reference
,cloud-tutorials
, andcloud-howtos
- The new canonical intersphinx project reference is just
cloud
- Those project references have been dissolved:
- UI: Increase z-index of feedback chooser content
- Update jquery to 3.7.0
- Update jinja2 to <3.2
- Adjust footer navigation after web site update. Thanks, @msbt.
- Fix admonition content styles for links and item lists
- Fix version chooser enablement
- Update to Sphinx
sphinx>=4.6,<7
- Add modern components from the Sphinx ecosystem: myst-parser, sphinx-design, sphinx-inline-tabs, sphinx-subfigure, sphinx-togglebutton, sphinxcontrib-mermaid.
- Refactor GitHub feedback component to separate files
- Migrate version chooser component to sphinx-design dropdown
- Use compact variant of GitHub feedback component at the top of the page
- Remove external links indicator
- Improve visual appearance of admonition components
- Add new
cloud-docs
documentation project
- Removed
code
-tag from a mobile media query to fix headlines font-sizes
- Change Crate.io logo to CrateDB
- Remove Crate.io footer logo
- Update Favicons
- Update the ESI fallback links in case we disable it at some point
- Use relative links to pages
- Update opengraph image
- Enable meta description via
ogp_enable_meta_description = True
- Fix wheel package.
- Fix visual appearance of Intersphinx references per
xref
CSS. Don't render links in bold text when using custom label. Happens, for example, with:class:dictionaries <py:dict>
.
- SQL-99: Replace regular buttons with HubSpot CTAs
- Fix error with switchover to
js-cookie
library
- Fix
js-cookie
library import
- Fix webpack expose configuration for
js-cookie
library
- Fix copying multi-line console snippets with
sphinx-copybutton
- Update JavaScript dependencies across the board
- Replace
jquery-cookie
withjs-cookie
- Add missing
loading="lazy"
to footer images
- Bump runtime dependency versions
- Bring CI setup up to speed
- Upgrade to Sphinx 5
- Search: Add message if no results were found
- Search: Don't show if
googleapis.com
doesn't respond - SEO: Change Open Graph description length from 300 to 150 characters
- UI: Make tables scroll horizontally on devices with <991px width
- UI: Remove whitespace at the top on SQL-99 on devices <991px width
- UI: Remove column layout from field lists on devices <560px width
- Fix
proxied_static_path
context variable following an RTD update
- Another hide navbar when opening anchor links fix
- Fix dropdown menu overlap
- Hide navbar when opening anchor links fix
- Add height attribute to crate.io logo to avoid CLS
- Hide navbar when opening anchor links
- Fix sidebar toc collapse setting
- Fix padding-top for SQL-99 documentation. Thanks, @msbt!
- Update Open Graph image. Thanks, @msbt!
- Improve menu structure of left-hand sidebar. Thanks, @jayeff!
- Fix path to ERDF footer logo
- Avoid reflow on content div element when loading the page
- Disable smooth scrolling
- SQL-99: Fix hover and active states of search button and search input field
- Style: Don't uppercase text, it doesn't look good with the new font
- Fix typo within "SQL-99 Complete, Really"
- Add an option to adjust the
html_context
of individual projects, for disabling the GitHub feedback box on the SQL-99 project.
- Add
html_context
variable to main configuration blueprint - Fixed mobile view on
search.html
- Provide different design for "SQL-99 Complete, Really" in order to more clearly separate it from the other documentation projects
- Use Sphinx-native search for "SQL-99 Complete, Really"
- Change primary font to
Inter
and secondary toPoppins
, removeBlender
- Prevent console errors when no navbar is available
- Disable GitHub feedback box on the SQL-99 project
- Fix regression: Bring back
pygments.css
inbase.html
- Visually hide injected footer (RTD-native version chooser) after enabling RTD API access
- Adjust
proxied_api_host
once more to fix RTD API access in reverse proxy scenarios
- Mitigate double include of
pygments.css
- Adjust
proxied_api_host
to make RTD footer and version data injection work in reverse proxy scenarios - Adjust dependencies to use Sphinx<4 and Jinja2<3.1
- Search: Don't trigger search without expression
- Search: Make navigation work even on
search.html
- Search: Only load
search.js
when actually visiting the search page - Adjust background color of version chooser
- Fix search
- New header (hides when scrolling down, comes back when scrolling up)
- Revamped search (added pagination, number of results, source)
- Fix inline Google Search API request
- Added
google_search_api_key
,google_search_cx_id
and the corresponding
to environment variables to init.py
and theme.conf
to improve search
- Added HubSpot newsletter footer include
- Fix for promo header
- Updated logo, favicon, icons, fonts and colors for design refresh
- Added promo header (
notif-include
) innavbar.html
- Re-added newsletter in
footer.html
placeholder for testing
- Updated/added ESI links/css for navi-header/footer to include HubSpot pages
- Added
theme_tracking_hubspot_id
andTRACKING_HUBSPOT_ID
toinit.py
andtheme.conf
- Footer now includes GitHub stars
- Updated fallback header and footer navi
- Included a higher res ERDF image
- Fix "align-left" and "align-right" directives: Don't use bold text on them.
- Fix sphinx-copybutton appearance.
- Improve contrast of highlighted code examples
- Harmonize heading styles
- Switch sphinx-copybutton cursor to pointer
- Improve sphinx-copybutton: Enable copying empty lines
- Add
|striptags
to the Segment titles for proper sanitizing - Improve version pinning
- Improve sphinx-copybutton: Also handle
PS>
prompt for Powershell - Improve top and bottom margins for headings
- Fix some client docs intersphinx URLs
- Adjust style of highlighted codeblocks: Border, border radius and shadow
- Improve OpenGraph og:url computation
- Fix
Uncaught TypeError: $.cookie is not a function
- Fix version dropdown by re-adding "Webflow: Front-end site library"
- Minor CSS fixup for glossary link
- Upgrade to crate-docs 2.0.0
- Permit installation on Sphinx 4
- Add intersphinx mapping for cross referencing documentation across different repositories
- Improve bundling of custom JavaScript and CSS assets
- Fix the docs title for Segment.io / GA tracking
- Add ESI snippets for a dynamic promotion header and newsletter footer
- Improve margins and rename section class to
w-canvas
for proper tagging - Add extension "sphinxcontrib.plantuml"
- Add extension "sphinxext.opengraph"
- Add "sphinx-copybutton" extension
- Use Pygments style "material" for code highlighting
- Add doing_docs config module (hidden menu item)
- Fix list styling in admonition blocks
- Glossary links are now styled black with a dotted underline
- Fix a typo (character case) in sidebartoc.html causing the TOC to not display for the Cloud How-Tos project
- Preloading the full star of the rating system to prevent empty stars
- Added a note about
custom.css
andcustom.js
- Fix sidebar TOC . Previously, Sphinx was not expanding the sidebar TOC for both how-to projects.
- Added meta description to index.rst for testing
- Properly aligned footer container with the others
- Changed crate.io logo from png to svg
- Changed to svg stars from characters so all platforms look the same
- Changed menu from fontawesome bars to spans
- Fixed minor regressions from last update (borders, indents)
- Excluded internal links from external link icon
- Removed fontawesome.js
- SEO: Added rel="noopener" to Github links (links to cross-origin destinations are unsafe)
- Updated/removed Bootstrap and jQuery packages (nine vulnerabilities detected)
- SEO: Added height: auto; to the logo css (lighthouse cought a wrong AR)
- SEO: Added alt & title tags to logos in header and footer
- Moved esi to the correct position
- SEO: Added dns-prefech/preconnect to googleapis.com and cdn.crate.io
- Updated version tag for css/js in base.html for cleaner caches
- SEO: Added language xml:lang="en" lang="en"
- Added Favicon
- SEO: Preloading Font
- SEO: Minified/Combined static js/css files (except custom and doctools)
- SEO: Removed maximum-scale=1 from meta viewport to allow zooming
- Added new rating feature below the feedbackbox
- SEO: Changed h3 to h2 for feedbackbox and new rating
- Fixed a minor css error in crateio.css and added font-display: swap;
- Fixed colors of the Toggle Doc Menu (mobile)
- Add left-margin to all lists
- Fix paragraph margins for lists using the "open" class
- Permit installation with more recent versions of Sphinx by relaxing strict
dependency on
Sphinx==1.8.5
- Update to
sphinxcontrib-plantuml==0.19
- Added WordPress navi as edge side include via Varnish
- Added bottom margin to code highlights
- New icons and colors for admonitions
- Dropped unnecessary versioned sphinx requirement specified by docs project
- Changed url for Try CrateDB to the CrateDB Cloud anchor
- Excluded images from external link indicator
- Fix typo in URL for Clients & Tools
- Add class to exclude feedback box links from external link indicator
- The sitemap_url_scheme setting is now manually configured so that sitemap links work correctly when built locally and on Read The Docs.
- Change sitemap name to site.xml
- Add page title to issue search to filter out false positives for root index.html page (and potentially other scenarios)
- Switch default issue label from "area: docs" to "team: tech writing"
- Fix subheading link styles so they are consistent with <h1> elements
- Change sitemap name to crate.xml to see if that works with RTD
- Add padding-top to the current menu item
- Change link color to fit the new one on crate.io
- Add external link indicator
- Add configuration to change sitemap name
- Remove html_extra_path for crate-howtos.py
- Add config to implement custom robots.txt
- Update docs projects config files to match sphinx-sitemap upgrade
- Update sphinx-sitemap to latest version
- Updated GitHub label to "area: docs"
- Added comparison page
- Rearranged partner page
- Removed comparison from footer
- Updated navbar and footer to match main website
- Downgraded Sphinx dependency to 1.8.5 (matches new RTD default)
- Updated dependency to Sphinx 3.1.2
- Removed hardcoded segment tracking ID. Instead, this is now settable in the
project's
conf.py
, or by exporting theTRACKING_SEGMENT_ID
environment variable during the build.
- Fixed links in pre-filled text in docs issue template
- Improved Feedback section (one fetch instead of two) and updated tracking
- Fixed project titles
- Fixed search string
- Fixed use of HTML suffix
- New issues now come with pre-filled template text
- Feedback section now only shows issues that relate to the current page
- Re-enable GitHub Feedback section
- Disabled GitHub Feedback section for more testing
- Added GitHub Feedback section
- Added new Clients and Tools project to CrateDB section
- Split off links to client library docs projects and drop "Clients" menu item
- Deleted unused modules
- Fixed template logic
- Moved Admin UI and Crash into the CrateDB section.
- Updates for docs reshuffle, including nav bar update and module name changes.
- Edited a function that shows/hides the toggled docs menu on mobile.
- Changed
z-index
ofheader.header-nav
soversion-select-container
won't overlap on mobile - Changed
Edit on GitHub
link fromblob
toedit
inlayout.html
- Removed a function that hides the toggled docs menu on mobile.
- Changed
width
to100%
andmax-width
to400px
on.main-nav
for tablet and mobile to prevent overflow on smaller devices incustom.css
. - Added
minWidth: 992
forsticky-sidebar
tolayout.html
to fix scroll issues on mobile devices. - Removed
60px
padding in.toctree
to get rid of the whitespace. - Added
20px
margin below to.bs-docs-sidebar
so theh1
won't overlap.
- Aligned docs nav bar to the website and in regard to the latest product addition
- Added CrateDB Cloud on Azure
- Deleted comparison page
- Updated top nav and bottom nav to match site
- Removed Getting Started navigation link
- Made Tutorials link un-hidden
- Update GitHub shortcut Ctrl + e
- Add (hidden) CrateDB Tutorials project
- Update Python conf module names to reflect current docs structure
- Add a "view on GitHub" button
- Add a key shortcut Ctrl + e to open the GitHub page.
- Display Cloud Getting Started link
- Remove title attribute from navigation links
- Upgrade docs utils to 0.1.11
- Add Cloud Getting Started project
- Fix bolding of literals in left-hand navigation menu
- Upgrade to docs style 0.1.10
- Improve left-hand navigation menu scrolling
- Add stub documentation project for testing the theme
- Add new standalone config module for documentation projects that don't appear in the navigation menu
- Revamp package build system
- Removed unused docutils.conf file
- Update package description
- Bump required Python version to 3.7
- Tidy up .gitignore
- Tidy up top-level documentation
- Improved navigation menu scroll behaviour.
- Fixed style of <code> titles in navigation menu.
- Removed mmenu.all.min.js library.
- Updated LICENSE and NOTICE.
- Removed Python 2 in favour of Python 3.
- Removed setuptools requirement.
- Link to the IoT Data Platform docs is hidden unless you are currently viewing those docs.
- Added new CrateDB Cloud IoT Data Platform docs project. This includes a new template config module and a change to the HTML navigation menu.
- Unreleased
- Change the
html_context
keys for custom js/css scripts fromscript_files
toextra_script_files
and fromcss_files
toextra_css_files
. This change fixes a regression that was introduced in0.5.73
which allowed the build process on RTD to "inject" their css/js using thescript_files
/css_files
keys of the html context.
- Change depth of toc tree of Cloud CLI project to 2.
- Allow per-project additional script files by specifying
script_files
in the project'shtml_context
(inconf.py
). - Allow per-project additional css files by specifying
css_files
in the project'shtml_context
(inconf.py
).
- Aligned doc footer and website footer
- Remove Slack button
- Fix sitemap
- Update project URLs
- Add Croud docs
- Fix link to CrateDB Cloud docs
- Fixed config issue
- Add CrateDB Cloud to navigation
- Fix support link
- Update navigation to match primary website
- Retitle Npgsql navigation link
- Fix .NET config module
- Add .NET client and fix navigation
- Increase SQL-99 TOC level in the side navigation
- Add SQL-99 docs project (hidden for now)
- Add admonition graphics and change admonition styles
- Add step to update setuptools to DEVELOP.rst
- Fixed an issue that caused the search to contain HTML in the preview
- Update navbar
- Add trailing slash to links
- Fix template error
- Added new docs project for Admin UI
- Added dependency to sphinx_sitemap
- Added new menu
- Correct nested list margin
- Adjust sidebar div styling
- Fix heading link color
- Added bottom margin to imgs
- Fix link
- Fix build for epub builder
- Add getting started docs
- Chop off en/latest when building alt version links
- Conditionally apply canonical url patch based on builder type
- Update canonical URLs to use "en/latest"
- Force canonical URL override on RTD
- Limit sidebar height and scroll the overflow
- Remove link styling from content headings
- Style admonition links to be more visible
- Add some bottom margin to the tables for spacing
- Hide mobile nav toggle on desktop viewport
- Improvements for mobile browsers
- Remove topic div border
- Add search results structure to jQuery function
- Correct HTML structure for search results
- Minor style changes
- Fixed the scroll jerk issue on the sidebar
- Updated the navbar to match the newer version on the website
- Expanded container layout to match newer design
- Added search documentation button to sidebar
- Improved styling of search results page
- Added custom.js and custom.css for easy front-end changes
- Debug release
- fixed and updated segment tracking code
- Removed debug code
- Debug release
- Debug release
- Debug release
- Dropped favicon config
- Updated canonical URL config
- Increase TOC depth for CrateDB guide
- Drop Java docs from navigation
- Drop Mesos docs from navigation
- Update navigation for docs reorganisation
- Fix display of literals
- Fix issue that caused the doc navigation to not be displayed
- Fix CSS filename and HTML indentation
- Fix CSS issues
- Bump version for new upload
- Updated header and footer to match main website
- Fixed issue that caused the search result links to be broken
- Added style for tip type admonitions
- Added style for caution type admonitions
- Conf file for mesos was missing
- Added menu item for mesos-framework docs
- Fix missing favicon
- Fixing menu scroll for long menus
- Made h4 tag style more consistent
- removed /stable from canonical url
- Added padding to stop system scroll bars obscuring code
- fixed links in footer to exclude .html also updated facebook link
- Fixed layout issue that caused a layout overlapping of results on search page
- Host
searchtools.js
in local theme since RTD has overrided the integrated search of Sphinx.
- Changed docs menu to allow for new structure and 'scale' section
- Changed Links to Downloads and Docs
- Fixed menu expansion issue
- Changed font size
- Code highlighting improved
- Changed menu titles
- Changed Overview link
- set up new layout
- Added new project configurations for crate-pdo, crate-dbal, and crate-ruby
- Removed two links in the top nav as quick fix for new website
- Fixed the links in the footer section for the new urls
- New section Use Cases
- updated Segment analytics snippet
- send events separate ID with extended attributes
- IP is now owned by Crate.IO GmbH
- signup for newsletter added
- fixed broken links in page header
- removed support for Google Analytics tracking
- updated CSS to new Crate look & feel
- added support for LeadLander analytics
- updated favicon
- renamed 'Crate Data' to 'Crate' and 'Crate Data JDBC Driver' to 'Crate JDBC Driver'
- make navigation highlightling follow page scrolling correctly
- added styles for 'seealso' and 'todo' color boxes
- added docutils.conf to specify max length of field names
- hardcoded canonical url to make documentation public on read the docs
- added segment.io analytics
- fixed internal page links so section headline is visible when selecting from left hand navigation
- decreased font size in version list
- fixed not closed html tag
- load Google font from https or http depending on doc URL
- new style to match website design
- added support for tracking via segment.io
- upgraded to google universal analytics tracking code
- fixed css selector for code literals in tables
- do not break table header lines and code literals in tables
- added conf for crate jdbc driver
- fix: linebreaks in code blocks
- added conf for java client
- fixed crash config
- make urls in version dropdown absolute
- changed package structure to crate.theme.rtd
- Initial theme