Skip to content

New documentation formatting #1080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

New documentation formatting #1080

wants to merge 1 commit into from
+6,022 −1,866

Conversation

grisumbras
Copy link
Member

No description provided.

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@grisumbras grisumbras force-pushed the doc/asciidoc branch 2 times, most recently from 645a3ef to 6711989 Compare April 11, 2025 14:28
@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

1 similar comment
@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@grisumbras grisumbras force-pushed the doc/asciidoc branch 2 times, most recently from 4b77739 to f83c053 Compare April 11, 2025 15:01
@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@grisumbras grisumbras force-pushed the doc/asciidoc branch 2 times, most recently from 795804e to 404be92 Compare April 17, 2025 13:11
@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@grisumbras
Copy link
Member Author

@sdarwin I'm switching JSON docs to asciidoctor. I've changed the image that tests docs to the same one used for Boost releases, and also changed the script. Can you update the preview script too? Or ideally, we can come up with a way to control how the preview is generated from the project sources themselves.

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@codecov Codecov
Copy link

codecov bot commented Apr 17, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.70%. Comparing base (0b1048a) to head (bd66f3b).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1080   +/-   ##
========================================
  Coverage    93.70%   93.70%           
========================================
  Files           91       91           
  Lines         9139     9139           
========================================
  Hits          8564     8564           
  Misses         575      575
Files with missing lines Coverage Δ
include/boost/json/array.hpp 100.00% <ø> (ø)
include/boost/json/basic_parser.hpp 100.00% <ø> (ø)
include/boost/json/impl/serialize.ipp 95.60% <ø> (ø)
include/boost/json/value_from.hpp 100.00% <ø> (ø)
include/boost/json/value_to.hpp 100.00% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0b1048a...bd66f3b. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@sdarwin
Copy link
Collaborator

sdarwin commented Apr 17, 2025

Hi @grisumbras , no changes in doc generation are needed. :-)

Some details to consider though.

Previous preview link:
https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html
New preview link:
https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/json/index.html

Since past versions of boost were using doc/html/index.html , if you really plan to modify the path of the docs, place a static html file (or a dynamically generated one) at the doc/html/index.html based on this example: https://github.com/boostorg/json/blob/develop/index.html If anyone fiddles with the URL in the browser and visits the previous doc/html/index.html they will get redirected to the new doc location.

Even better would be to consider the example of boostorg/charconv. Here is a preview URL:

https://228.charconv.prtest.cppalliance.org/libs/charconv/doc/html/index.html

In other words, charconv doesn't add an extra layer of redirection ( an extra /charconv/ in the path ) and continues to use doc/html/index.html . Could that be done?

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1080.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

@cppalliance-bot
Copy link

pullrequest
Benchmark test results. More info at https://benchmark.cppalliance.org/jsonbenchmarks-pullrequests/1080/pullrequest.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@grisumbras @cppalliance-bot @sdarwin