Skip to content

Doc: Update documentation to build cleanly in Sphinx 3#7978

Merged
bneradt merged 1 commit intoapache:masterfrom
SolidWallOfCode:doc-sphinx-3-update
Jul 1, 2021
Merged

Doc: Update documentation to build cleanly in Sphinx 3#7978
bneradt merged 1 commit intoapache:masterfrom
SolidWallOfCode:doc-sphinx-3-update

Conversation

@SolidWallOfCode
Copy link
Member

This also requires Sphinx 3 or better to build the documentation.

There are a number of new C and C++ domain directives in Sphinx 3, which makes the docs more expressive. Sphinx 3 also does noticeably more syntax checking, which broke many bits of the existing documentation.

@bneradt
Copy link
Contributor

bneradt commented Jul 1, 2021

The doc/Pipfile specifies Sphinx 3.x and the CI systems are now running Sphinx 3.x (thanks @zwoop ). This change should be good to go.

@bneradt bneradt merged commit 07250b7 into apache:master Jul 1, 2021
@zwoop zwoop modified the milestones: 10.0.0, 9.2.0 Sep 23, 2021
@zwoop zwoop changed the title Doc: Update documentation to build cleanly in Sphinx 3. Doc: Update documentation to build cleanly in Sphinx 3 Oct 14, 2021
moonchen pushed a commit to moonchen/trafficserver that referenced this pull request Mar 7, 2022
* asf/master: (763 commits)
  rate_limit: Add a global hook to rate limit concurrent connections based on SNI (apache#8021)
  Fix uri_signing unit test for out of source builds (apache#8040)
  tests: Add conditions for BoringSSL and OpenSSL (apache#8045)
  change debug tags and make sure sni is printed on certain logs (apache#7673)
  Doc build in CI: build English docs with -W (apache#8039)
  When loading async SSL configuration file fails, log SSL error (apache#8036)
  Doc build: treat warnings as errors only by default (apache#8038)
  For test async_engine, export all symbols (apache#8037)
  Fix the server cert reload (apache#8030)
  Treat Sphinx doc build warnings as errors. (apache#8033)
  Stablize trace curl test in good_request_after_bad (apache#8032)
  Doc: Update documentation to build cleanly in Sphinx 3. Require Sphinx 3 or better. (apache#7978)
  Docs: Fix pre-formatting for ratelimit plugin (apache#7986)
  Make it slightly harder to dump private keys to logs (apache#8029)
  tls_bad_alpn: Add an openssl version skip check (apache#8026)
  per thread jemalloc arena for MADV_DONTDUMP (apache#7501)
  Adds a new rm-destination, this lets you specify either QUERY or PATH, and be able to drop them from the incoming request (apache#8025)
  Fix HPACK eviction iterator manipulation (apache#8004)
  Do not invalidate cached resources upon error responses to unsafe methods (apache#7999)
  Cleanup SSLUtils (apache#8007)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants