|
Warning: this is an htmlized version!
The original is here, and the conversion rules are here. |
####### # # E-scripts on Sphinx - i.e., python-sphinx, sphinx-build, etc. # # Note 1: use the eev command (defined in eev.el) and the # ee alias (in my .zshrc) to execute parts of this file. # Executing this file as a whole makes no sense. # An introduction to eev can be found here: # # (find-eev-quick-intro) # http://angg.twu.net/eev-intros/find-eev-quick-intro.html # # Note 2: be VERY careful and make sure you understand what # you're doing. # # Note 3: If you use a shell other than zsh things like |& # and the for loops may not work. # # Note 4: I always run as root. # # Note 5: some parts are too old and don't work anymore. Some # never worked. # # Note 6: the definitions for the find-xxxfile commands are on my # .emacs. # # Note 7: if you see a strange command check my .zshrc -- it may # be defined there as a function or an alias. # # Note 8: the sections without dates are always older than the # sections with dates. # # This file is at <http://angg.twu.net/e/sphinx.e> # or at <http://angg.twu.net/e/sphinx.e.html>. # See also <http://angg.twu.net/emacs.html>, # <http://angg.twu.net/.emacs[.html]>, # <http://angg.twu.net/.zshrc[.html]>, # <http://angg.twu.net/escripts.html>, # and <http://angg.twu.net/>. # ####### # «.python3-sphinx» (to "python3-sphinx") # «.idris» (to "idris") # «.pngmath-imgmath» (to "pngmath-imgmath") # «.texinfo» (to "texinfo") * (eepitch-shell) * (eepitch-kill) * (eepitch-shell) pip3 help pip3 list pip3 list | grep -i sphinx w pip w pip3 # (find-esgrep "grep --color -niH -e sphinx *.e") # (find-esgrep "grep --color -niH -e sphinx *.e | grep -i pip") # (find-es "python" "python-sphinx") # (find-es "python" "sphinx-build") # (find-es "python" "sphinx-git") sudo pip install -U sphinx * (eepitch-shell) * (eepitch-kill) * (eepitch-shell) w sphinx-build ##### # # python3-sphinx # 2019oct22 # ##### # «python3-sphinx» (to ".python3-sphinx") # (find-es "python" "sphinx-build") # (find-zsh "installeddebs | sort | grep sphinx") # (find-zsh "availabledebs | sort | grep sphinx") # (find-sh "apt-file search sphinx-build") # python-sphinx: /usr/share/sphinx/scripts/python2/sphinx-build # python3-sphinx: /usr/share/sphinx/scripts/python3/sphinx-build # (find-status "python3-sphinx") # (find-vldifile "python3-sphinx.list") # (find-udfile "python3-sphinx/") # (find-status "sphinx-common") # (find-vldifile "sphinx-common.list") # (find-udfile "sphinx-common/") # (find-status "sphinx-doc") # (find-vldifile "sphinx-doc.list") # (find-udfile "sphinx-doc/") # (find-udfile "sphinx-doc/html/") # file:///usr/share/doc/sphinx-doc/html/index.html # (find-man "1 sphinx-build") # (find-man "1 sphinx-build" "-d <path>") # (find-fline "/usr/bin/sphinx-build") ##### # # How idris uses sphinx-build to build its pdf docs # 2019oct22 # ##### # «idris» (to ".idris") # (find-es "idris" "idris-git") # (find-es "idris" "idris-git" "make user_doc_pdf |& tee omudp") # (find-fline "~/usrc/Idris-dev/") # (find-fline "~/usrc/Idris-dev/omudp") # sphinx-build -b latex -d _build/doctrees . _build/latex # (find-man "1 sphinx-build" "sphinx-build [options] <sourcedir> <outdir>") # (find-man "1 sphinx-build" "-b <builder>") # (find-man "1 sphinx-build" "-d <path>") # (find-fline "~/LOGS/2019oct22.idris") * (eepitch-shell) * (eepitch-kill) * (eepitch-shell) pip3 install sphinx pip3 install sphinx_rtd_theme # (find-es "idris" "idris-ct") ##### # # pngmath-imgmath # 2020dec23 # ##### # «pngmath-imgmath» (to ".pngmath-imgmath") # https://github.com/sphinx-doc/sphinx/issues/6182 # -> pngmath module was removed since 1.8. The successor is sphinx.ext.imgmath # https://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.imgmath ##### # # texinfo # 2022sep19 # ##### # «texinfo» (to ".texinfo") # (find-fline "~/LOGS/2022sep19.emacs" "<grym> edrx: sphinx will happily spit out info") # https://www.sphinx-doc.org/en/master/_modules/sphinx/builders/texinfo.html # https://github.com/python/cpython/blob/main/Doc/README.rst#building-the-docs, # https://github.com/python/cpython/blob/main/Doc/Makefile#L93 # Local Variables: # coding: utf-8-unix # End: