Comments (26)
So this was a separate page linked to from the documentation page?
from mapserver-documentation.
I just checked a 6.4 build, and the file with the index is build/html/genindex.html.
The file name is the same for 7.0 (http://mapserver.org/genindex.html), but there the link is not shown anymore.
The link used to be in white text on the right side in a thick horizontal blue line below the flags.
from mapserver-documentation.
All translations have the blue line with the index link. It is only on the main language (English) page that the blue line with the index link is missing.
The following is the blue line for the German translation:
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="Stichwortverzeichnis"
accesskey="I">Index</a></li>
<li class="right" >
<a href="about.html" title="Hintergrund"
accesskey="N">weiter</a> |</li>
<li class="nav-item nav-item-0"><a href="#">Home</a> »</li>
</ul>
</div>
When compiling the docs locally, the blue line shows up also for the main language "front" page:
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="about.html" title="About"
accesskey="N">next</a> |</li>
<li><a href="#">Home</a> »</li>
</ul>
</div>
from mapserver-documentation.
@jmckenna, could you have a look at this? I think the current situation is very unfortunate, as it makes navigating the documentation very difficult for those that use the default (English) version of the documentation.
from mapserver-documentation.
Update:
Now the blue navigation line has also disappeared from the (non-US) translations.
To recap: When compiling locally, the blue line shows up as expected. The code that brings up the line is:
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="grid.html" title="GRID"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="fontset.html" title="FONTSET"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Home</a> »</li>
<li><a href="../documentation.html" >MapServer 7.0.0 Documentation</a> »</li>
<li><a href="index.html" accesskey="U">Mapfile</a> »</li>
</ul>
</div>
That code comes directly after the table that contains the translation links (with flags). On mapserver.org, the code is not there.
A lot of effort has been put into the MapServer documentation index, and it is a real shame that it is not available. With the large amount of documentation, having access to the index is essential!
from mapserver-documentation.
Hi @havatv I will take a look
from mapserver-documentation.
The current status is that I have fixed the default English page to include the navigation bar (apparently my fix helped another Sphinx community who was stuck on this for months, ha). But I haven't figured out yet why it won't appear on any of the translated pages.
I did figure out why locally for my own builds I would have duplicate navigation bars. It turns out that Sphinx uses several default "layout.html" files, and I had to check a few of them locally on my own machine:
- C/Python26/Lib/site-packages/sphinx-1.3.1-py2.6.egg/sphinx/themes/basic/layout.html
- C/Python26/Lib/site-packages/alabaster-0.7.4-py2.6.egg/alabaster/layout.html
- and of course ours at /_templates/layout.html
If you are a doc maintainer and you have duplicate navigation bars for local builds, I'd ask you just live with them for now, and be happy for now that travis-ci.org and mapserver.org has at least 1 navigation bar (for English).
I will keep digging on this. Not easy, as unfortunately this is all done through travis-ci.org "cloud" builds. PS I hate the cloud.
from mapserver-documentation.
Thanks for the quick fix, @jmckenna!
from mapserver-documentation.
I've been looking into this issue recently. The "alabaster" theme became the default for Sphinx within the last year, and hides the relbar by default.
See Lib\site-packages\alabaster\layout.html
{# Disable base theme's top+bottom related navs; we have our own in sidebar #}
{%- block relbar1 %}{% endblock %}
{%- block relbar2 %}{% endblock %}
By explicitly setting the theme to classic (which is what was used by Sphinx previously) the bar comes back. There is also one at the bottom - this can be overriden in the MapServer layout.html if needed.
from mapserver-documentation.
indeed, that i why i mentioned alabaster earlier here (C/Python26/Lib/site-packages/alabaster-0.7.4-py2.6.egg/alabaster/layout.html).
from mapserver-documentation.
@jmckenna - looking at the alabaster theme it seems it is nearly all overridden anyway, so by bypassing that in the conf.py file the docs should build with the navigation bar on the travis-ci build?
from mapserver-documentation.
the issue before was making this all work both locally and on Travis, indeed I did spend much time on that.
from mapserver-documentation.
Let us see how it goes on Travis......
from mapserver-documentation.
@geographika please check how your changes look on mapserver.org (Travis) now. Likely it is the same result and explanation as I said in my earlier Oct 21 comment.
from mapserver-documentation.
@jmckenna http://mapserver.org/ looks good for me now - at least it has the blue bar back underneath the title so you can navigate more easily between sections (and access the index).
The translated versions still have it missing, but it appears they were not updated by the Travis build. They still refer to the Alabaster theme at the bottom of the page.
from mapserver-documentation.
@geographika the blue bar was back, on mapserver.org, placed back through my Oct 21 changes. The only issue remaining was the blue bar on the translated pages. (in your case, you likely had both issues, as I mentioned back on Oct 21).
from mapserver-documentation.
in any case, the issue then and the issue now is the darn blue bar, only on translated pages, and only on Travis/mapserver.org So, the issue remains open :)
from mapserver-documentation.
Anyway I am fine if you want to close this, but in my mind the issue exists the same now as it did on Oct 21. Maybe I am wrong, I am often wrong :)
from mapserver-documentation.
Maybe all that is needed is a [build_translations] commit?
from mapserver-documentation.
darn Travis :)
from mapserver-documentation.
I'll try to build all translations on Travis now...
from mapserver-documentation.
translations are building now on travis: https://travis-ci.org/mapserver/docs/builds/167503564
from mapserver-documentation.
@geographika can you check mapserver.org now?
from mapserver-documentation.
(i had to clear my browser cache) ok too many messages from me I guess! Cheers from Canada.
from mapserver-documentation.
Looks good now!
The blue bar had been missing again on mapserver.org for the last few weeks - I think due to the requirements.txt update on August 23rd 2016. I had the blue bar locally until I changed to alabaster version 0.7.9 which removed the relbar - sphinx-doc/alabaster@f82f9db
from mapserver-documentation.
True, I bet as I had been updating requirements.txt that a recent change killed it again for good ha (I also have Alabaster 0.7.9 locally). Thanks @geographika and great teamwork! Yikes this one was tricky. I think we can mark this as closed. (!!) Cross your fingers.
from mapserver-documentation.
Related Issues (20)
- Revise PackageListing Page to Show that OSGeo4W Installs of MapServer are Not Supported or Have Deprecated HOT 2
- Document WMS-C TILED=YES WEB.METADATA "tile_map_edge_buffer"
- Undocumented WEB EXTENT keyword HOT 2
- Undocumented STYLE POSITION keyword HOT 1
- Undocumented STYLE SIZEUNITS keyword HOT 3
- CGI Controls Document
- installation procedure not up-to-date HOT 1
- Symbol Construction pages do not include examples of truetype symbol fills for polygons HOT 1
- Update docs to Remove URL update functionality HOT 1
- Compfilter description is missing in the COMPISTE page HOT 5
- Vector Tile Support HOT 1
- Update for new FlatGeobuf native type HOT 1
- WMS time - create tileindex with time - example
- Layer plugin documentation needs update to reflect plugins section in config file HOT 1
- Tutorial broken and can use some more guidance for new 8.0 version? HOT 4
- Link in SLD doc returns an exception HOT 1
- reprojectionObj is missing from the SWIG MapScript documentation HOT 1
- suggested improvements on docs for building docs HOT 2
- link bahaviour on subsections
- OGC API: Document the metadata item "oga_compliance_mode"
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mapserver-documentation.