[Geocoding] Documentation and issue #809

[Sarah Hoffmann]

On Sun, Apr 26, 2020 at 08:45:47AM +0530, K Rahul Reddy wrote:
> Hi Sarah,
> 
> Thanks for
> 
> I installed Pygments 2.6.1 through pip, and built the documentation(mkdocs
> version 1.1). The tree structure looks fine locally for me(screenshot
> attached - The file names are bold and extensions are normal, is it fine?).
> The html elements being built are slightly different for me as compared to
> the nominatim.org website. There might be some version difference in some
> other package. Please let me know if I am missing anything.

Thanks. That was the hint I needed. Pygments was in fact not installed
correctly, so that's what went wrong. Alos, I've been using the mkdocs
and pygments versions that ship with Debian stable. Apparently, that's
too old. I've switched to the latest releases from pip now and it comes
out correctly formatted and with colors. I'll update the installation
instructions for the documentation.

Sarah

> 
> I noticed that all the code blocks on [1], were limited to one line. I
> traced it back to the file 'theme_extra.css'.  The css file received by [1]
> is different from the one at [2](Mkdocs master and V1.1). The website now
> receives css similar to the file at [3](Mkdocs V1.0). I am not sure why this
> is happening.
> 
> [1] https://nominatim.org/release-docs/develop
> 
> [2]
> https://github.com/mkdocs/mkdocs/tree/master/mkdocs/themes/readthedocs/css
> 
> [3]
> https://github.com/mkdocs/mkdocs/blob/1.0.dev/mkdocs/themes/readthedocs/css <https://github.com/mkdocs/mkdocs/blob/1.0.dev/mkdocs/themes/readthedocs/css/theme_extra.css>
> 
> Regards,
> 
> Rahul
> 
> On 25/04/20 7:56 pm, Sarah Hoffmann wrote:
> > On Sat, Apr 25, 2020 at 11:16:03AM +0100, Sarah Hoffmann wrote:
> > > Hi Rahul,
> > > 
> > > On Fri, Apr 24, 2020 at 03:48:01PM +0530, K Rahul Reddy wrote:
> > > > The Advanced installations
> > > > <https://nominatim.org/release-docs/develop/admin/Advanced-Installations/>
> > > > documentation page has some color issues(screenshots attached). These did
> > > > not exist in my local build. Is there any way of solving them?
> > > That's an old version of mkdocs. I'm on it.
> > The new version of mkdocs has fixed the colors but it breaks your
> > nice file tree. :( The reason it looks different from yours at
> > home is that I've installed pygments[1] in the server. Usually
> > that's what we want because the highlighting makes the
> > code snippets more readable. The problem is that I just can't see
> > to convince it to not format the file tree code block. Maybe you
> > can find a way. If not, we have to disable pygements again.
> > 
> > [1] https://python-markdown.github.io/extensions/code_hilite/#step-1-download-and-install-pygments
> > 
> > Sarah