Change Log

Hint

You may want to learn about our Release Strategy

Version 3.x

🏷️ 3.0

Note

This version is still under development and has not been released yet.

Warning

This version contains INCOMPATIBLE changes.

  • Render ability improvements. The ability to render data is now provided by sphinxnotes-render (💬30)

    • BREAKING: The any_schemas confval is replcated by 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 (💬28)

    • External header now works for definition list, field list now, (💬52)

    • Support datetime type in field

    • Add ToC entry for object descriptions (🚀57)

  • Index improvements:

    • Add multiple indices support (🚀40)

    • Support index by path (🚀42)

    • Support index by datetime (💬33, issue:35)

  • Support dumping domain data, see also any_domain_dump (🚀50)

See also

The 3.0 tracking issue: 💬15

Version 2.x

🏷️ 2.5
Date:

📅2024-08-17

Download:

🏷️2.5

  • Add new Sphinx Domain classifier (🚀27)

  • Strip rST markups in index description (🚀32)

  • refactor: Combing and document srcdir, outdir, reldir

  • Fix referenceable field with multiple lines form (💬34)

🏷️ 2.4.0
Date:

📅2023-08-26

Download:

🏷️2.4.0

  • Re-org project with sphinx-notes/template (🚀20)

  • Require wand>0.6.11 to prevent crash on macOS (fa716d3)

🏷️ 2.3.1
Date:

📅2022-06-26

Download:

🏷️2.3.1

  • Fix crash when noting object with duplicate reference (💬18)

🏷️ 2.3
Date:

📅2022-04-09

Download:

🏷️2.3

  • Prevent crash when failed to get section title (72250de)

  • Return hexdigest rather than UUID as object ID (🚀7)

  • Make all filters works again (🚀8)

  • Correctly rendering title of cross reference (🚀12)

🏷️ 2.2
Date:

📅2021-08-18

Download:

🏷️2.2

  • Use the Object ID as index name when no object title available

🏷️ 2.1
Date:

📅2021-06-26

Download:

🏷️2.1

  • Report ambiguous object via debug log

  • Some doc fixes

  • Remove unused import

🏷️ 2.0
Date:

📅2021-06-05

Download:

🏷️2.0

  • Update documentation, add some tips

🏷️ 2.0a3
Date:

📅2021-06-03

Download:

🏷️2.0a3

  • Simplify index name (e4d9207)

🏷️ 2.0a2
Date:

📅2021-05-23

Download:

🏷️2.0a2

  • Fix none object signture (6a5f75f)

  • Prevent sphinx config changed everytime (f7b316b)

🏷️ 2.0a1
Date:

📅2021-05-23

Download:

🏷️2.0a1

  • Template variable must be non None (fb9678e)

  • Template will not apply on role with explicit title (5bdaad1)

🏷️ 2.0a0
Date:

📅2021-05-22

Download:

🏷️2.0a0

  • Descibing schema with python object instead of dict

  • Support index

  • Refactor

Version 1.x

🏷️ 1.1
Date:

📅2021-02-28

Download:

🏷️1.1

  • Remove symbol link if exists

🏷️ 1.0
Date:

📅2021-02-23

Download:

🏷️1.0

  • Move preset schemas to standalone package

  • Add custom filter support to template

  • Combine any_predefined_schemas and any_custom_schemas to any_schemas

🏷️ 1.0b0
Date:

📅2021-01-28

Download:

🏷️1.0b0

  • Fix the missing Jinja dependency

  • Use section title as object name when directive argument is omitted

  • Some code cleanups

  • Rename schema field “role” to “reference”

  • Rename schema field “directive” to “content”

🏷️ 1.0a1
Date:

📅2020-12-20

Download:

🏷️1.0a1

The alpha version is out, enjoy~