#sphinx-doc

/

      • jet1
        fading, I figured out what you were helping with yesterday. Thanks! I didn't change anything in my configuration or directory structure, but I changed my references in rst source files. Since absolute paths are relative to the source directory, and my images are a level above my source, I thought I should just be able to use ".." to go up to that level, but I actually needed the path to start with a forward slash. So it turns out that
      • fading
        eh
      • you got cut off
      • jet1
        oh sorry...
      • fading
        I'm surprised you can .. out of source directory
      • jet1
        yeah!
      • fading
        all I got was: but I actually needed the path to start with a forward slash. So it turns out that
      • cliffhanger
      • jet1
        haha
      • So it turns out that I cannot say, for example, (.. image:: ../images/test.png), but if the path starts with a "/", it will work. Like this: (.. image:: /../images/test.png)
      • fading
        weird
      • so what does html look like?
      • jet1
        yeah weird. But thanks for encouraging that I be persistent about the absolute path.
      • fading
        I mean is it generally legal for html to ref stuff ABOVE the html / dir?
      • I would have thought that was security issue
      • jet1
        So now the sphinx-build finds the files and copies them to the build directory like we expect.
      • fading
        I mean it might work on your build machine but if you deploy that html to a real webserver will it still work?
      • jet1
        right. the html looks like this: (src="../../../_images/test.png")
      • depending on where the rst file is.
      • So it just makes relative paths in the html.
      • fading
        seems like real web servers wouldn't let you go outside the html root dir?
      • jet1
        Well the contents actually build into the web server root.
      • fading
        otherwise you could get to passwd file
      • jet1
        So that path I gave was from a deeper nested doc.
      • Yeah you are correct. It's all relative paths but under the root dir.
      • sontek has left the channel
      • fading
        o okay
      • neat trick
      • willingc_away is now known as willingc
      • jet1
        Yeah. Now I can have separate version control for my rst source files. I have a git repository that contains my config files, build files, and images. My source files are isolated in a git submodule for that repository. I also can move my rst files around in my "source" repo, and they will always find my images because of absolute path references.
      • So thanks again. It all works as I'd like.
      • fading
        just dumb luck on my part :) I never thought to try what you eventually did
      • [20-100] joined the channel
      • [20-100]
        Hello. I was wondering if I could document a constant (with #:) but without displaying it's value.
      • changing the behaviour either globally, or for specific documented file, or even for each specific constant
      • my goal is to explain what's in the constant, but showing it is not relevant and it's a bit huge
      • I haven't been able to find a way to do this, so thanks if you have any advice :)
      • Oh, I'v found :annotation: But the thing is, as I'm using autodoc to document every object of a file, I cannot specify annotations manually, can I set an annotation for a whole file ?
      • kushal joined the channel
      • pratikse1 joined the channel
      • pratikse1 has quit
      • Not-522e
        [02sphinx] 07birkenfeld deleted branch 031719_numfig_format_was_ignored_on_latex
      • [02sphinx] 07birkenfeld pushed 031 commit to 03master [+0/-0/±1] 13http://git.io/xple
      • [02sphinx] 07birkenfeld 03b45fec3 - add hint for test suite to readme
      • [02sphinx] 07birkenfeld pushed 032 commits to 031719_numfig_format_was_ignored_on_latex [+0/-0/±5] 13http://git.io/xELz
      • [02sphinx] 07tk0miya 031ee7f5a - #1719 Use numfig_format for prefix of captions in LaTeX builder
      • [02sphinx] 07tk0miya 039f06027 - #1719 Add prefix to linkname of :numref: on LaTeX mode
      • wirrrbel joined the channel
      • untitaker joined the channel
      • wirrrbel
        I was looking into how sphinx could produce docbook xml
      • naively, I thought it would produce a docbook book
      • Ah
      • now I got it
      • docutils xml != docbook xml
      • ionelmc joined the channel
      • guillemBarba joined the channel
      • wirrrbel has quit
      • wirrbel joined the channel
      • wirrbel has quit
      • wirrbel joined the channel
      • wirrbel has quit
      • wirrbel joined the channel
      • jamie_h joined the channel
      • wirrbel has quit
      • ljosberinn joined the channel
      • pratikse1 joined the channel
      • guillemBarba has quit
      • guillemBarba joined the channel
      • shaun_ joined the channel
      • shaun_
        hi guys would any of u know how one could colour code highlight inline text in Python Sphinx? I'd like to shade certain text in certain colours and also if possible have all identical links highlighted if the mouse is moved over one link.
      • wirrbel joined the channel
      • wirrbel
        if I were to write a sphinx builder with the target of Docbook XML output
      • how would I start, or rather: Which builder could work as a template?
      • fading joined the channel
      • pratikse1 has quit
      • guillemBarba has quit
      • guillemBarba joined the channel
      • wirrbel has quit
      • wirrbel joined the channel
      • [20-100] has left the channel
      • shaun_ has quit
      • pratikse1 joined the channel
      • wirrbel has quit
      • guillemBarba has quit
      • pratikse1_ joined the channel
      • guillemBarba joined the channel
      • pratikse1 has quit
      • pratikse1_ has quit
      • pratikse1 joined the channel
      • guillemBarba has quit
      • guillemBarba joined the channel
      • ddom joined the channel
      • guillemBarba has quit
      • pratikse1 has left the channel
      • jamie_h has quit
      • wirrbel joined the channel
      • wirrbel has quit
      • Kurama joined the channel
      • wirrbel joined the channel
      • wirrbel has quit
      • wirrbel joined the channel
      • Kurama has quit
      • wirrbel has quit