Source.Python/docs/_modules/autodoc.html at v743 · Source-Python-Dev-Team/Source.Python

History

356 lines (291 loc) · 26.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

<!DOCTYPE html>

<head>

<title>autodoc — Source.Python v742 documentation</title>

</head><body>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../index.html"> Source.Python v742 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">autodoc</a></li>

</ul>

</div>

<h1>Source code for autodoc</h1><div class="highlight"><pre>

# ../autodoc.py

"""This module provides a class to create documentation automatically."""

# =============================================================================

# >> IMPORTS

# =============================================================================

# Python

import sys

from path import Path

# =============================================================================

# >> ALL DECLARATION

# =============================================================================

__all__ = ('SphinxError',

'SphinxProject',

)

# =============================================================================

# >> CLASSES

# =============================================================================

class SphinxError(Exception):

"""Exception raised when creating, building, or generating Sphinx docs."""</div>

class SphinxProject(object):

"""Representation of a Sphinx project."""

def __init__(self, package_dir, project_dir):

"""Initialize the Sphinx project object.

:param str package_dir:

The path to the package to document.

:param str project_dir:

The path to the Sphinx project or where it should be saved.

"""

self._package_dir = Path(package_dir)

self._project_dir = Path(project_dir)

self.validate_package()</div>

@property

def project_dir(self):

"""Return the project directory.

:rtype: Path

"""

return self._project_dir

@property

def project_source_dir(self):

"""Return the project source directory.

:rtype: Path

"""

return self.project_dir / 'source'

@property

def project_build_dir(self):

"""Return the project build directory.

:rtype: Path

"""

return self.project_dir / 'build'

@property

def package_dir(self):

"""Return the package directory as a Path object.

:rtype: Path

"""

return self._package_dir

def project_exists(self):

"""Return True if the Sphinx project exists.

:rtype: bool

"""

return self.project_dir.is_dir()</div>

def package_exists(self):

"""Return True if the package exists.

:rtype: bool

"""

return self.package_dir.is_dir()</div>

def create(self, author, project_name=None, version='1'):

"""Create a new Sphinx project.

:param str author:

Name of the package author.

:param str project_name:

Name of the project that is displayed in the documentation. If

None, it will be the name of the package.

:param str version:

Project/package version.

:raise ValueError:

Raised if the project already exists.

:raise ValueError:

Raised if the package does not exist.

:raise SphinxError:

Raised if an error occured during the creation.

"""

if self.project_exists():

raise ValueError('The project already exists.')

self.validate_package()

self.project_dir.mkdir()

from sphinx.cmd.quickstart import main

if project_name is None:

project_name = self.package_dir.name

argv = [

'-q', # Don't start the interactive mode

f'-p {project_name}',

f'-a {author}',

f'-v {version}',

self.project_dir,

'--sep', # Separate source and build directory

'--ext-autodoc', # Enable autodoc

'--no-makefile',

'--no-batchfile'

]

try:

main(argv)

except:

raise SphinxError</div>

def generate_project_files(self, sub_dir=''):

"""Generate the project files (`*.rst` files).

:param str sub_dir:

A sub-directory of the :attr:`project_source_dir` where the module

documentation will be generated in.

:raise ValueError:

Raised if the project and/or package does not exist.

:raise SphinxError:

Raised if an error occured during the generation.

"""

self.validate_project_and_package()

from sphinx.ext.apidoc._cli import main

argv = [

'-e', # Separate pages/files for every module

'-o',

str(self.project_source_dir / sub_dir),

str(self.package_dir), # Package to document

]

try:

main(argv)

except:

raise SphinxError</div>

def build(self, clean=False):

"""Build the Sphinx project.

:param bool clean:

If True a clean build will be created.

:raise ValueError:

Raised if the project and/or package does not exist.

:raise SphinxError:

Raised if an error occured during the build.

"""

self.validate_project_and_package()

if clean:

self.project_build_dir.rmtree_p()

add_to_path = self.package_dir not in sys.path

if add_to_path:

sys.path.append(str(self.package_dir.parent))

from sphinx.cmd.build import main

argv = [

str(self.project_source_dir),

str(self.project_build_dir),

]

try:

main(argv)

except SystemExit as e:

if e.code != 0:

raise SphinxError

finally:

if add_to_path:

sys.path.remove(str(self.package_dir.parent))</div>

def quickstart(self, author, project_name=None, version='1'):

"""A wrapper for creating, generating, and building documentation.

:param str author:

Author of the project.

:param str project_name:

Name of the project.

:param str version:

Version of the project.

"""

if not self.project_exists():

self.create(author, project_name, version)

self.generate_project_files()

self.build()</div>

def validate_project_and_package(self):

"""Validate the project and package.

:raise ValueError:

Raised if the project or package does not exist.

"""

self.validate_project()

self.validate_package()</div>

def validate_project(self):

"""Validate the project.

:raise ValueError:

Raised if the project does not exist.

"""

if not self.project_exists():

raise ValueError(

'Create the project before generating project files.')</div>

def validate_package(self):

"""Validate the package.

:raise ValueError:

Raised if the package does not exist.

"""

if not self.package_exists():

raise ValueError('The package does not exist.')</div>

</div>

</pre></div>

</div>

</a>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

>index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../index.html"> Source.Python v742 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="index.html" >Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">autodoc</a></li>

</ul>

</div>

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

autodoc.html

Latest commit

History

autodoc.html

File metadata and controls