[libcxx-commits] [PATCH] D111926: [libc++][doc] Use sphinx variables to make updating the docs version easier

[Mark de Wever via Phabricator via libcxx-commits]

Mordante added a comment.

I really like the direction this patch is taking. I want to give it another testrun after the runtime builds are fixed.
(I still use a non-runtime build.)



================
Comment at: libcxx/docs/ReleaseNotes.rst:3
+Libc++ |version| |ReleaseNotesTitle|
+==================================================
 
----------------
Please resize line 1 and 3 to match line 2.


================
Comment at: libcxx/docs/conf.py:54
 # The full version, including alpha/beta/rc tags.
-release = '14.0'
+release = version + 'git'
 
----------------
tstellar wrote:
> tstellar wrote:
> > Mordante wrote:
> > > Mordante wrote:
> > > > The current output "libc++ 14.0.0git documentation" looks weird.
> > > I expect for a release I'd have to remove `+ 'git'`, but doing so results in errors when building the documentation.
> > > ```
> > > make[3]: *** [projects/libcxx/docs/CMakeFiles/docs-libcxx-html.dir/build.make:58: projects/libcxx/docs/CMakeFiles/docs-libcxx-html] Error 2
> > > make[2]: *** [CMakeFiles/Makefile2:25091: projects/libcxx/docs/CMakeFiles/docs-libcxx-html.dir/all] Error 2
> > > make[1]: *** [CMakeFiles/Makefile2:25098: projects/libcxx/docs/CMakeFiles/docs-libcxx-html.dir/rule] Error 2
> > > make: *** [Makefile:7544: docs-libcxx-html] Error 2
> > > ```
> > > Do I misunderstand the intention or is there a real error?
> > I decided to drop the 'git' suffix in order to simplify the config.  I can add it back (with the '-' in front of it) if you think it helps remind readers that it is a pre-release.
> The version string is 14.0.0git again now that I'm using PACKAGE_VERSION directly from CMake.  This form of the version string is used in other places, so I would lean towards just keeping it as is.
Since we use `14.0.0git` in other places I agree we should be consistent and do the same in the documentation.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D111926/new/

https://reviews.llvm.org/D111926