Skip to content

use Python version of Docca #61

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.

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .drone.star
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def main(ctx):
linux_cxx("S390x: Clang 12", "clang++-12", packages="clang-12 libstdc++-9-dev", llvm_os="focal", llvm_ver="12", buildtype="boost", buildscript="drone", image="cppalliance/droneubuntu2004:multiarch", environment={'B2_TOOLSET': 'clang-12', 'B2_CXXFLAGS': '-Werror', 'B2_CXXSTD': '17,20'}, arch="s390x", globalenv=globalenv),

# Documentation
# linux_cxx("Docs", "g++", packages="docbook docbook-xml docbook-xsl xsltproc libsaxonhe-java default-jre-headless flex libfl-dev bison unzip rsync", buildtype="docs", buildscript="drone", image="cppalliance/droneubuntu1804:1", environment={'COMMENT': 'docs'}, globalenv=globalenv),
# linux_cxx("Docs", "g++", packages="docbook docbook-xml docbook-xsl python3-jinja2 xsltproc flex libfl-dev bison unzip rsync", buildtype="docs", buildscript="drone", image="cppalliance/droneubuntu1804:1", environment={'COMMENT': 'docs'}, globalenv=globalenv),

# CMake tests (https://github.com/boostorg/boost-ci)
## Compiling as part of the boost superproject
Expand Down
9 changes: 2 additions & 7 deletions .drone/drone.sh
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,7 @@ elif [ "$DRONE_JOB_BUILDTYPE" == "docs" ]; then
cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Release
cd build
sudo make install
cd ../..
if [ ! -f saxonhe.zip ]; then wget -O saxonhe.zip https://sourceforge.net/projects/saxon/files/Saxon-HE/9.9/SaxonHE9-9-1-4J.zip/download && echo "not-cached"; else echo "cached"; fi
unzip -o saxonhe.zip
sudo rm /usr/share/java/Saxon-HE.jar
sudo cp saxon9he.jar /usr/share/java/Saxon-HE.jar
cd ..
cd ../../..
BOOST_BRANCH=develop && [ "$TRAVIS_BRANCH" == "master" ] && BOOST_BRANCH=master || true
git clone -b $BOOST_BRANCH https://github.com/boostorg/boost.git boost-root --depth 1
cd boost-root
Expand All @@ -80,7 +75,7 @@ elif [ "$DRONE_JOB_BUILDTYPE" == "docs" ]; then

echo '==================================> SCRIPT'

echo "using doxygen ; using boostbook ; using saxonhe ;" >tools/build/src/user-config.jam
echo "using doxygen ; using boostbook ; using python : : python3 ;" >tools/build/src/user-config.jam
./b2 -j3 libs/$SELF/doc//boostrelease

elif [ "$DRONE_JOB_BUILDTYPE" == "codecov" ]; then
Expand Down
26 changes: 13 additions & 13 deletions doc/Jamfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,23 @@

project static_string/doc ;

import-search /boost/docca ;

import boostbook ;
import type ;
import docca ;
import path ;
import os ;
import ../../../tools/docca/docca.jam ;
import type ;

docca.reference reference.qbk
local include-prefix = [ path.root $(__file__:D) [ path.pwd ] ] ;
include-prefix = [ path.native $(include-prefix:D)/include ] ;

docca.pyreference reference.qbk
:
xsl/custom-overrides.xsl
[ glob-tree-ex ../include/boost/static_string : *.hpp *.ipp : detail impl ]
externals.hpp
:
<doxygen:param>PROJECT_NAME=StaticString
<doxygen:param>PROJECT_BRIEF="Static String Library"
<doxygen:param>ALIASES="esafe=\"@par Exception Safety\""
<doxygen:param>FILE_PATTERNS=
<doxygen:param>EXAMPLE_PATTERNS=
<doxygen:param>DISTRIBUTE_GROUP_DOC=YES
<doxygen:param>MACRO_EXPANSION=YES
<doxygen:param>EXPAND_ONLY_PREDEF=YES
Expand All @@ -40,19 +42,17 @@ docca.reference reference.qbk
<doxygen:param>EXTRACT_ALL=YES
<doxygen:param>EXTRACT_PRIVATE=YES
<doxygen:param>EXTRACT_LOCAL_CLASSES=NO
<doxygen:param>SHOW_INCLUDE_FILES=NO
<doxygen:param>INLINE_INFO=NO
<doxygen:param>SORT_MEMBER_DOCS=NO
<doxygen:param>SORT_MEMBERS_CTORS_1ST=YES
<doxygen:param>SHOW_USED_FILES=NO
<doxygen:param>SHOW_FILES=NO
<doxygen:param>SHOW_NAMESPACES=NO
<doxygen:param>CLASS_DIAGRAMS=NO
<doxygen:param>STRIP_FROM_PATH=$(include-prefix)

# <doxygen:param>ALLOW_UNICODE_NAMES=NO
# <doxygen:param>GROUP_NESTED_COMPOUNDS=NO
# <doxygen:param>HIDE_COMPOUND_REFERENCE=NO
# <doxygen:param>WARN_AS_ERROR=NO

<docca:config>config.json
;

#-------------------------------------------------------------------------------
Expand Down
12 changes: 12 additions & 0 deletions doc/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"include_private": false,
"legacy_behavior": false,
"external_marker": "!EXTERNAL!",
"link_prefix": "static_string.ref.",
"default_namespace": "boost::static_strings",
"allowed_prefixes": ["boost::static_strings::", "std::"],
"convenience_header": "boost/static_string.hpp",
"replace_strings": {
"__see_below__": "``['see-below]``"
}
}
64 changes: 64 additions & 0 deletions doc/externals.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
#pragma once

namespace boost {

/// !EXTERNAL!
///
/// @see https://www.boost.org/doc/libs/release/libs/utility/doc/html/utility/utilities/string_view.html
template <class T, class Traits>
struct basic_string_view {};

} // namespace boost

namespace std {

/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/iterator/reverse_iterator
template <class T>
struct reverse_iterator {};

/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/size_t
struct size_t {};

/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/integer
struct uint64_t {};

/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/integer
struct int64_t {};

/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/nullptr_t
struct nullptr_t {};

/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/ptrdiff_t
struct ptrdiff_t {};

/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/utility/initializer_list
template <class T>
struct initializer_list {};

/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/io/basic_ostream
template <class T, class Traits>
struct basic_ostream {};

/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/numeric_limits
template <class T>
struct numeric_limits {};

} // namespace std
11 changes: 0 additions & 11 deletions doc/xsl/custom-overrides.xsl

This file was deleted.

2 changes: 1 addition & 1 deletion include/boost/static_string/static_string.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -913,7 +913,7 @@ throw_exception(const char* msg)
basic_static_string<N, char8_t, std::char_traits<char8_t>>;
@endcode

@see to_static_string
@see @ref to_static_string.
*/
template<std::size_t N, typename CharT,
typename Traits = std::char_traits<CharT>>
Expand Down
Loading