python - Customize templates for `sphinx-apidoc` -


i've tried using sphinx-apidoc sphinx generate sphinx specific restructuredtext api of python project.

however, result i'm getting is:

default of <code>sphinx-api</code> result

anyone know if can customize template sphinx-api uses output? specifically, i'd to:

  • get rid of "submodules", "subpackages" , "module contents" headings, and
  • have results docstring in __init__.py files appear directly under packages, if click package name, first thing see package documentation. @ moment, documentation placed under weird "module contents" heading @ end of each package section.

the "submodules" , "subpackages" headings redundant think, since normal headings packages/modules "xxx.yyy package" , "xxx.yyy.zzz module".

the structure above small example is

  • orexplore.components package
    • orexplore.components.mbg120 module
  • orexplore.simulators package
    • orexplore.simulators.test package
      • orexplore.simulators.test.mbg120 module
    • orexplore.simulators.mbg120 module

where clicking packages, first thing i'd see on page package documentation.

or maybe just

  • orexplore.components
    • orexplore.components.mbg120
  • orexplore.simulators
    • orexplore.simulators.test
      • orexplore.simulators.test.mbg120
  • orexplore.simulators.mbg120

if there way visually distinguish packages/modules (color? emblem?) instead of quite wordy " package" , " module".

the sphinx-apidoc script uses apidoc.py module. not able provide detailed instructions, in order remove headings or otherwise customize output, you'll have write own version of module. there no other "template".

note if api , module structure stable, there no need run sphinx-apidoc repeatedly. can post-process generated rst files liking once , place them under version control. see https://stackoverflow.com/a/28481785/407651.


Comments

Post a Comment

Popular posts from this blog

r - Trouble relying on third party package imports in my package -

my package uses ggplot2 extensively make custom plots. import ggplot2 in namespace file. can build, install, , load package r without errors. when call function package, complains can't find function in imported package. function called had absolute nothing plotting , didn't make use of ggplot2 . how can make function calls package work without these types of errors? error in theme_beata() (from plot.r#14) : not find function "theme_classic" the first function erroring is: #' custom ggplot2 theme beata #' @import ggplot2 #' @family themes #' inheritparams ggplot2::theme_classic #' @export theme_beata <- function(base_size = 14, base_family="serif", ticks = true) { ret <- theme_classic() + theme(axis.line = element_line(size=0.6), axis.text = element_text(size = base_size), axis.title = element_text(size= base_size + 2), title = element_text(size=base_size + 4)) if (...
Read more

Payment information shows nothing in one page checkout page magento -

i using magento ver. 1.9.1.0 want remove shipping information , shipping method step 1 page checkout page. changed code in core file like in app\code\core\mage\checkout\block\onepage.php public function getsteps() { $steps = array(); $stepcodes = $this->_getstepcodes(); /* remove shipping address , shipping method */ $excludestep=array_diff($stepcodes,array('shipping','shipping_method')); //$excludestep=$stepcodes; if ($this->iscustomerloggedin()) { $stepcodes = array_diff($excludestep, array('login')); } foreach ($excludestep $step) { $steps[$step] = $this->getcheckout()->getstepdata($step); } return $steps; } and in app\code\core\mage\checkout\controllers\onepagecontroller.php public function savebillingaction() { if ($this->_expireajax()) { return; } if ($this->getrequest()-...
Read more