A Sphinx extension to generate changelog files. An experimental extension that's used by the SQLAlchemy project and related projects.
License: Other
This site uses zeekofile to build a static site, which can also be served locally using zeekofile.
Building and Testing:
#!/bin/bash virtualenv .venv source .venv/bin/activate pip install git+https://github.com/sqlalchemyorg/zeekofile git clone https://github.com/sqlalchemyorg/sqlalchemyorg cd sqlalchemyorg/ pip install -r requirements.txt zeekofile --serve
Then view:
http://127.0.0.1:8080
https://pypi.org/project/changelog/ says that latest version is 0.5.5 but looks like there is no any version tags here
the way changelog caches the environment data is causing it to be serialized in doctree files causing exponential growth. see sphinx-doc/sphinx#11354
The default changelog_sections which has values ["general", "rendering", "tests"].
I am trying to give some custom names in place of these which do not display as intended.
What is the purpose of changelog_sections? Maybe I misunderstood the Readme.
My intention is just to have two sub-sections: Features, Bugs, no tags, or anything.
And also, where do the words/tags - feature and bug are displayed?
I have used the same example Changelog that was used in Readme:
====================
Changelog for 1.5.6
====================
.. changelog::
:version: 1.5.6
:released: Sun Oct 12 2008
.. change::
:tags: general
:tickets: 27
Improved the frobnozzle.
.. change::
:tags: rendering, tests
:pullreq: 8
:changeset: a9d7cc0b56c2
Rendering tests now correctly render.
How I wanted (example)
the .rawsource attribute has been removed.
not sure how nobody noticed this as this release was in november 2021
Hi, I guess this is a bug. Suppose to have the following configuration (conf.py)
changelog_sections = ["Introduction", "Getting Started", "General" ]
changelog_inner_tag_sort = ["Improvement", "Change", "Bugfix", "New Feature"]
changelog_hide_sections_from_tags = True
And the following code somewhere in a .rst file
.. changelog::
:released: 30 November 2022
.. change::
:tags: New Feature, Getting Started
A Quick start was added
.. change::
:tags: Bugfix, General
Fixed a typo in the syntax of a command.
Everything is correctly generated, but the "Getting Started" tag is not stripped from the tag list:
Getting Started tag should be removed:
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.