Skip to content

Commit

Permalink
bump version 0.6.7 -> 0.6.8
Browse files Browse the repository at this point in the history
Fix test

Signed-off-by: Liran Funaro <[email protected]>
  • Loading branch information
liran-funaro committed Jan 19, 2025
1 parent 81ccbda commit 177e90f
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 16 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2023-2024, Liran Funaro.
Copyright (c) 2023-2025, Liran Funaro.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ test-diff:
@$(SPHINX_BUILD) -M markdown "$(SOURCE_DIR)" "$(BUILD_DIR)/overrides" $(SPHINX_OPTS) $(O) -a \
-D markdown_http_base="https://localhost" -D markdown_uri_doc_suffix=".html" \
-D markdown_docinfo=True -D markdown_anchor_sections=True -D markdown_anchor_signatures=True \
-D autodoc_typehints=signature
-D autodoc_typehints=signature -D markdown_bullet=-

@# Copy just the files for verification
@cp "$(BUILD_DIR)/overrides/markdown/auto-summery.md" "$(BUILD_DIR)/markdown/overrides-auto-summery.md"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A Sphinx extension to add markdown generation support.
## Install

```sh
pip3 install sphinx-markdown-builder==0.6.7
pip3 install sphinx-markdown-builder==0.6.8
```

## Usage
Expand Down
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "sphinx-markdown-builder"
version = "0.6.7"
version = "0.6.8"
description = "A Sphinx extension to add markdown generation support."
readme = "README.md"
authors = [{ name = "Liran Funaro", email = "[email protected]" }]
Expand Down Expand Up @@ -42,7 +42,7 @@ dev = [
Homepage = "https://github.com/liran-funaro/sphinx-markdown-builder"

[tool.bumpver]
current_version = "0.6.7"
current_version = "0.6.8"
version_pattern = "MAJOR.MINOR.PATCH[-TAG]"
commit_message = "bump version {old_version} -> {new_version}"
commit = true
Expand All @@ -65,6 +65,7 @@ push = false
]
"tests/source/conf.py" = [
"^version = \"{version}\"$",
"copyright = \"Copyright (c) 2023-YYYY, Liran Funaro.\"",
]
"tests/expected/overrides-auto-summery.md" = [
"<meta name=\"version\" content=\"{version}\"/>",
Expand Down
2 changes: 1 addition & 1 deletion sphinx_markdown_builder/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from sphinx_markdown_builder.builder import MarkdownBuilder

__version__ = "0.6.7"
__version__ = "0.6.8"
__docformat__ = "reStructuredText"


Expand Down
12 changes: 6 additions & 6 deletions tests/expected/overrides-auto-module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<meta name="author" content="Liran Funaro"/>
<meta name="copyright" content="Copyright (c) 2023-2024, Liran Funaro."/>
<meta name="version" content="0.6.7"/>
<meta name="copyright" content="Copyright (c) 2023-2025, Liran Funaro."/>
<meta name="version" content="0.6.8"/>

<a id="auto-module"></a>

Expand Down Expand Up @@ -50,16 +50,16 @@ Thanks to github.com/remiconnesson.
This is a function with two parameters.

* **Parameters:**
* **param1** – This is the first parameter.
* **param2** – This is the second parameter.
- **param1** – This is the first parameter.
- **param2** – This is the second parameter.

### func3(param1: [int](https://docs.python.org/3/library/functions.html#int), param2: [int](https://docs.python.org/3/library/functions.html#int))

This is a function with two parameters.

* **Parameters:**
* **param1** – Alice <sup>[1](#id3)</sup>.
* **param2** – Bon <sup>[2](#id4)</sup>.
- **param1** – Alice <sup>[1](#id3)</sup>.
- **param2** – Bon <sup>[2](#id4)</sup>.

<a id="references"></a>

Expand Down
4 changes: 2 additions & 2 deletions tests/expected/overrides-auto-summery.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<meta name="author" content="Liran Funaro"/>
<meta name="copyright" content="Copyright (c) 2023-2024, Liran Funaro."/>
<meta name="version" content="0.6.7"/>
<meta name="copyright" content="Copyright (c) 2023-2025, Liran Funaro."/>
<meta name="version" content="0.6.8"/>

<!-- Taken from https://github.com/FabianNiehaus/sphinx-markdown-builder-toctree-test -->
<!-- Sphinx-Markdown-Builder TocTree Test documentation master file, created by
Expand Down
4 changes: 2 additions & 2 deletions tests/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@


project = "sphinx_markdown_builder"
copyright = "Copyright (c) 2023-2024, Liran Funaro."
copyright = "Copyright (c) 2023-2025, Liran Funaro."
author = "Liran Funaro"
version = "0.6.7"
version = "0.6.8"

extensions = [
"sphinx.ext.autodoc", # Core library for html generation from docstrings
Expand Down
2 changes: 2 additions & 0 deletions tests/test_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
"markdown_anchor_signatures=True",
"-D",
"autodoc_typehints=signature",
"-D",
"markdown_bullet=-",
],
]
BUILD_PATH_OPTIONS = [BUILD_PATH, os.path.join(BUILD_PATH, "overrides")]
Expand Down

0 comments on commit 177e90f

Please sign in to comment.