獅身人面像（文檔工具）：在輸出中設置製表符寬度

如何在Pygments突出顯示的Sphinx代碼片段的HTML輸出中設置製表符寬度？默認情況下，它是令人討厭的8，但我想要4. 在Sphinx conf.py中找不到關於此設置的字樣。獅身人面像（文檔工具）：在輸出中設置製表符寬度

2009-11-06 jbasko

與S.洛特一致，即使在Java世界中，您也可以使用空格而不是製表符。 http://java.sun.com/docs/codeconv/html/CodeConventions.doc3.html#262 – 2009-11-06 13:14:56

對於某些人來說，切換到空格可能並不那麼容易：整個團隊的代碼庫可以很好地使用製表符，並提供使用空格的文檔不一致。將所有代碼更改爲使用一個代碼是不切實際的並且可能具有破壞性。獅身人面像適用於許多不同的語言和環境。最好的敘述文檔工具如果不支持製表符，那麼它就不會被破壞，這是因爲「PEP8，這就是爲什麼」的代碼已經被破壞，這是充其量只是短視和適得其反的結果。 – Shabbyrobe 2012-05-17 02:00:48

此外，我知道tabtil替代發生在docutils，而不是在獅身人面像，但獅身人面像受到嚴重影響的問題，應承擔一定的責任來處理它。 – Shabbyrobe 2012-05-17 02:04:30

您將需要編寫一個獅身人面像擴展。 Add your custom Lexer，並將其與VisibleWhitespaceFilter一起使用。

來源

2009-11-08 15:49:49 iElectric

我更新了獅身人面像到0.6.3和Pygments到1.1.1（pygmentize -V）。感動我的所有文件，然後將此添加到conf.py：畫質設置（應用程序）：從pygments.filters從pygments.lexers.compiled進口JavaLexer sphinx.highlighting進口詞法分析器導入VisibleWhitespaceFilter myLexer = JavaLexer （） myLexer.add_filter（VisibleWhitespaceFilter（spaces ='！'））; app.add_lexer（'java'，myLexer）; 這將我的Java代碼中的所有選項卡替換爲八個「！」和「！」的所有空間如預期。當我嘗試選項標籤='！'時，沒有任何改變。當我嘗試選項tabsize = 4時，沒有任何改變。 – jbasko 2009-11-09 15:13:01

看起來標籤已被之前的某個地方的空間替換。因此，我試圖添加此過濾器到其他詞法分析器（其餘，沒有）[與詞法分析器['rest']。add_filter（...）]，但沒有任何影響選項卡或製表符。 – jbasko 2009-11-09 15:13:39

我問了關於sphinx-dev組的相同問題，結果發現這是Sphinx使用的Docutils的問題。 Docutils將所有標籤替換爲8個空格，並且目前無法從Sphinx更改該值。

http://groups.google.com/group/sphinx-dev/browse_thread/thread/35b8071ffe9a8feb

唯一可行的解決方案似乎是遵循美國洛特和約翰Paulett建議在評論我的問題 - 用空格代替製表符。

來源

2009-11-30 09:51:16 jbasko

添加這樣的事情你conf.py：

import re 

def process_docstring(app, what, name, obj, options, lines): 
    spaces_pat = re.compile(r"({8})") 
    ll = [] 
    for l in lines: 
     ll.append(spaces_pat.sub(" ",l)) 
    lines[:] = ll 

def setup(app): 
    app.connect('autodoc-process-docstring', process_docstring)

又見獅身人面像Docstring preprocessing文檔。

來源

2012-10-02 23:02:08 gieffe

獅身人面像（文檔工具）：在輸出中設置製表符寬度

回答

相關問題