Code review comment for lp:~ian-clatworthy/bzr/doc-site-per-language

Revision history for this message
Martin Pool (mbp) wrote :

That looks pretty good. Certainly it's a very nice cleanup of an ugly part of the makefile. My only real concern is the copy & paste of the version number.

Does this add a new hard dependency on anything? If so, we should be careful of the impact on distributions and packagers.

Thanks for fixing the style of NEWS.

1547 +
1548 +# We *could* get this from bzrlib but there's no certainly that the bzr on
1549 +# the Python path is indeed the one we're building the documentation for ...
1550 +bzr_version = (2, 0, 0, 'rc', 2)
1551 +
1552 +

urk, you're right that just 'import bzrlib' will be problematic, but this is almost certainly going to become incorrect. If from the Makefile you do "PYTHONPATH=.:$PYTHONPATH" then future loads of bzrlib should see the right thing.

Especially because it occurs not once but three or more times.

+release = version + ''.join(str(p) for p in bzr_version[3:])

Could you import and use _format_version_tuple?

+http://doc.bazaar-vcs.org/developers/.

Put it in angle brackets so the . isn't part of the url? (I guess it's harmless.)

2079 Bazaar Developer Document Catalog
2080 =================================
2081
2082 -
2083 -Overall developer documentation
2084 -===============================
2085 -
2086 -* `Developer Guide <../en/developer-guide/HACKING.html>`_
2087 -
2088 -* `Architectural Overview <overview.html>`_ |--| describes some of the
2089 - most important classes and concepts.
2090 +.. toctree::
2091 + :hidden:
2092 +
2093 + process
2094 + HACKING
2095 + testing
2096 + overview
2097 + integration
2098 + plans
2099 + specifications
2100 + implementation-notes
2101 + miscellaneous-notes
2102 +
2103 +
2104 +Core developer documentation

What does this do?

Could sphinx help us get away from manually maintaining indexes of documentation?

« Back to merge proposal