Skip to content

docs: Update changelog for version 3.0 #58

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.

Sign up for GitHub

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

Open
SilverRainZ wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Update changelog for version 3.0 #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 29 additions & 0 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,35 @@ Change Log

Change log here.

Version 3.x
===========

.. version:: 3.0
:break:

- Render ability improvements. The ability to render data is now provided by
`sphinxnotes-render`__ (:issue:`30`)

- **BREAKING**: The ``any_schemas`` confval is replcated by :confval:`any_object_types`,
and we use a new DSL for descibing a field (tbd: link to dsl)
- **BREAKING**: The ``sphinxnotes.any.api`` package is removed
- Add object embedding support (:issue:`28`)
- External header now works for definition list, field list now, (:issue:`52`)
- Support datetime type in field
- Add ToC entry for object descriptions (:pull:`57`)

- Index improvements:

- Add multiple indices support (:pull:`40`)
- Support index by path (:pull:`42`)
- Support index by datetime (:issue:`33`, issue:`35`)

- Support dumping domain data, see also :confval:`any_domain_dump` (:pull:`50`)

.. seealso:: The 3.0 tracking issue: :issue:`15`

__ https://sphinx.silverrainz.me/render/

Version 2.x
===========

Expand Down