Skip to content

Commit 3bb6737

Browse files
author
Marek Suchánek
committed
Announce the deprecation of this version and the migration to the new one
1 parent e8656b1 commit 3bb6737

File tree

4 files changed

+11
-6
lines changed

4 files changed

+11
-6
lines changed

newdoc/README.rst

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
###########################
2-
README: The `newdoc` script
3-
###########################
1+
########################################
2+
README: The `newdoc` script (DEPRECATED)
3+
########################################
4+
5+
**DEPRECATED:** This version of `newdoc` is now deprecated and will no longer receive any significant updates. Please uninstall this version and migrate to the current version: https://github.com/redhat-documentation/newdoc.
46

57
This script is used for generating empty module and assembly files when writing Red Hat or Fedora documentation in AsciiDoc. The generated files follow template guidelines set up by the Modular Documentation initiative: https://redhat-documentation.github.io/modular-docs/.
68

newdoc/newdoc.spec

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
%global srcname newdoc
22

33
Name: python-%{srcname}
4-
Version: 1.5.0
4+
Version: 1.5.1
55
Release: 1
66
Summary: A script to generate assembly and module AsciiDoc files from templates
77

newdoc/newdoc/newdoc.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
import argparse
88
from string import Template
99

10-
NEWDOC_VERSION = "1.5.0"
10+
NEWDOC_VERSION = "1.5.1"
11+
DEPRECATION = "DEPRECATED:\nThis version of `newdoc` is now deprecated and will no longer receive any significant updates.\nPlease uninstall this version and migrate to the current version:\nhttps://github.com/redhat-documentation/newdoc"
1112

1213
# The configparser module is called ConfigParser in Python2
1314
import configparser as cp
@@ -268,6 +269,8 @@ def main():
268269
"""
269270
Main, executable procedure of the script
270271
"""
272+
print(DEPRECATION, "\n")
273+
271274
# Build a command-line options parser
272275
parser = argparse.ArgumentParser()
273276

newdoc/setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
setuptools.setup(
88
name="newdoc",
9-
version="1.5.0",
9+
version="1.5.1",
1010
license="GPLv3+",
1111
author="Marek Suchánek",
1212
author_email="[email protected]",

0 commit comments

Comments
 (0)