@@ -3,7 +3,6 @@ from typing import Final
3
3
from typing_extensions import deprecated
4
4
5
5
from docutils import SettingsSpec
6
- from docutils .frontend import OptionParser
7
6
from docutils .io import FileInput , Input , Output
8
7
from docutils .parsers import Parser
9
8
from docutils .readers import Reader
@@ -33,18 +32,10 @@ class Publisher:
33
32
destination_class = ...,
34
33
settings : dict [str , Incomplete ] | None = None ,
35
34
) -> None : ...
36
- def set_reader (self , reader_name : str , parser : Parser | None , parser_name : str | None ) -> None : ...
35
+ def set_reader (self , reader : str , parser : Parser | None = None , parser_name : str | None = None ) -> None : ...
37
36
def set_writer (self , writer_name : str ) -> None : ...
37
+ @deprecated ("The `Publisher.set_components()` will be removed in Docutils 2.0." )
38
38
def set_components (self , reader_name : str , parser_name : str , writer_name : str ) -> None : ...
39
- @deprecated ("Publisher.setup_option_parser is deprecated, and will be removed in Docutils 0.21." )
40
- def setup_option_parser (
41
- self ,
42
- usage : str | None = None ,
43
- description : str | None = None ,
44
- settings_spec : SettingsSpec | None = None ,
45
- config_section : str | None = None ,
46
- ** defaults ,
47
- ) -> OptionParser : ...
48
39
def get_settings (
49
40
self ,
50
41
usage : str | None = None ,
@@ -64,7 +55,7 @@ class Publisher:
64
55
** defaults ,
65
56
) -> None : ...
66
57
def set_io (self , source_path : StrPath | None = None , destination_path : StrPath | None = None ) -> None : ...
67
- def set_source (self , source = None , source_path : StrPath | None = None ) -> None : ...
58
+ def set_source (self , source : str | None = None , source_path : StrPath | None = None ) -> None : ...
68
59
def set_destination (self , destination = None , destination_path : StrPath | None = None ) -> None : ...
69
60
def apply_transforms (self ) -> None : ...
70
61
def publish (
@@ -88,11 +79,11 @@ default_description: Final[str]
88
79
89
80
def publish_cmdline (
90
81
reader : Reader [Incomplete ] | None = None ,
91
- reader_name : str = "standalone" ,
82
+ reader_name : str | None = None ,
92
83
parser : Parser | None = None ,
93
- parser_name : str = "restructuredtext" ,
84
+ parser_name : str | None = None ,
94
85
writer : Writer [Incomplete ] | None = None ,
95
- writer_name : str = "pseudoxml" ,
86
+ writer_name : str | None = None ,
96
87
settings = None ,
97
88
settings_spec = None ,
98
89
settings_overrides = None ,
@@ -108,11 +99,11 @@ def publish_file(
108
99
destination = None ,
109
100
destination_path : StrPath | None = None ,
110
101
reader = None ,
111
- reader_name : str = "standalone" ,
102
+ reader_name : str | None = None ,
112
103
parser = None ,
113
- parser_name : str = "restructuredtext" ,
104
+ parser_name : str | None = None ,
114
105
writer = None ,
115
- writer_name : str = "pseudoxml" ,
106
+ writer_name : str | None = None ,
116
107
settings = None ,
117
108
settings_spec = None ,
118
109
settings_overrides = None ,
@@ -124,11 +115,11 @@ def publish_string(
124
115
source_path : StrPath | None = None ,
125
116
destination_path : StrPath | None = None ,
126
117
reader = None ,
127
- reader_name : str = "standalone" ,
118
+ reader_name : str | None = None ,
128
119
parser = None ,
129
- parser_name : str = "restructuredtext" ,
120
+ parser_name : str | None = None ,
130
121
writer = None ,
131
- writer_name : str = "pseudoxml" ,
122
+ writer_name : str | None = None ,
132
123
settings = None ,
133
124
settings_spec = None ,
134
125
settings_overrides = None ,
@@ -141,11 +132,11 @@ def publish_parts(
141
132
source_class = ...,
142
133
destination_path : StrPath | None = None ,
143
134
reader = None ,
144
- reader_name : str = "standalone" ,
135
+ reader_name : str | None = None ,
145
136
parser = None ,
146
- parser_name : str = "restructuredtext" ,
137
+ parser_name : str | None = None ,
147
138
writer = None ,
148
- writer_name : str = "pseudoxml" ,
139
+ writer_name : str | None = None ,
149
140
settings = None ,
150
141
settings_spec = None ,
151
142
settings_overrides : dict [str , Incomplete ] | None = None ,
@@ -157,9 +148,9 @@ def publish_doctree(
157
148
source_path : StrPath | None = None ,
158
149
source_class = ...,
159
150
reader = None ,
160
- reader_name : str = "standalone" ,
151
+ reader_name : str | None = None ,
161
152
parser = None ,
162
- parser_name : str = "restructuredtext" ,
153
+ parser_name : str | None = None ,
163
154
settings = None ,
164
155
settings_spec = None ,
165
156
settings_overrides = None ,
@@ -170,13 +161,14 @@ def publish_from_doctree(
170
161
document ,
171
162
destination_path : StrPath | None = None ,
172
163
writer = None ,
173
- writer_name : str = "pseudoxml" ,
164
+ writer_name : str | None = None ,
174
165
settings = None ,
175
166
settings_spec = None ,
176
167
settings_overrides = None ,
177
168
config_section : str | None = None ,
178
169
enable_exit_status : bool = False ,
179
170
): ...
171
+ @deprecated ("The `publish_cmdline_to_binary()` is deprecated by `publish_cmdline()` and will be removed in Docutils 0.24." )
180
172
def publish_cmdline_to_binary (
181
173
reader = None ,
182
174
reader_name : str = "standalone" ,
0 commit comments