Python Sphinx/rest substitution for long names defining substitution rule in same source file -

-

post python sphinx referencing long names provided 1 answer close looking regards substitution directives long class names.

def examplefunction():     '''here example docstring referencing     |reallylongexampleclassname|      .. |reallylongexampleclassname| replace::                                      :class:`.reallylongexampleclassname`

in example provided however, definition replacement rule within same pydoc block. hoping this:

"""define rst links/substitutions used in file .. |reallylongexampleclassname| replace:: :class:`.reallylongexampleclassname` .. |anotherexampleclassname| replace:: :class:`.anotherexampleclassname` """  # more code # more code   def examplefunction():     '''here example docstring referencing     |reallylongexampleclassname|      # define function

since every file in question specific, use of rst_epilog doesn't extend well. possible.

you can variable rst_epilog in conf.py file. taken straight rst_epilog:

rst_epilog

a string of restructuredtext included @ end of every source file read. right place add substitutions should available in every file. example:

rst_epilog = """ .. |psf| replace:: python software foundation """

but rst_epilog not fit use case. perhaps rst include directive better approach? can put commonly used substitutions single rst document , include in documents need use them.


Comments

Post a Comment

Popular posts from this blog

javascript - Slick Slider width recalculation -

-
i'm trying add slide in panel on slick container css. carousel works except new width not being calculated when space has been added. recalibrate once advance next slide i'd happen each time panel opened or closed. i've tried adding both margin , padding, neither makes difference. ideas? https://jsfiddle.net/mhigley/dpf7mlpl/ html: <button type="button" id="button"><i class="fa fa-arrow-right"></i></button> <aside> <h2>slide in panel</h2> <ol> <li>list item</li> <li>list item</li> <li>list item</li> <li>list item</li> <li>list item</li> </ol> </aside> <main role="main"> <div class="sections"> <section> <article> <h2>first slide</h2> <p>lorem ipsum d...
Read more

jsf - PrimeFaces Datatable - What is f:facet actually doing? -

-
looking through primefaces code in app noticed following line: <f:facet name="header">#{trainsearch.traincount} trains</f:facet> it looks overriding header, makes sense, can explain me in little more detail? what happening line of code? complete code listed below: <p:datatable id = "results" value = "#{trainsearch.trains}" var = "train" rendered="#{not empty trainsearch.trains}" styleclass = "train-search-table horizontal-border"> <f:facet name="header">#{trainsearch.traincount} trains</f:facet> <p:column headertext = "train id"> <p:panelgrid columns="1" styleclass = "train-id-grid" layout = "grid"> <h:outputtext styleclass = "train-id-label" value="#{train.traini}"/> <h:outputtex...
Read more

angular2 services - Angular 2 RC 4 Http post not firing -

-
i trying fire post request app , it's not working, tried multiple ways. don't see request being fired under network tab in chrome. not sure problem is, appreciated. import { injectable } '@angular/core'; import { http, headers } '@angular/http'; @injectable() export class userservice{ private _url="users"; constructor(private _http: http){ } checkifusernameexists(username){ return this._http.get(this._url+"/"+username) .map(response => response.json()) } createuser(user){ let headers = new headers(); headers.append('content-type', 'application/json') console.log(json.stringify(user)); return this._http.post(this._url, json.stringify(user),{headers: headers}) .map(response => response.json()) } } first need capture error , solve error: this._http.post(this._url, json.stringify(user),{headers: headers}) .subscribe( ...
Read more