Skip to content

Commit

Permalink
Fix other-archs CI builds
Browse files Browse the repository at this point in the history
  • Loading branch information
eliaskosunen committed Oct 28, 2023
1 parent 3ec3b21 commit f60b640
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/arch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
run: |
cmake -G Ninja -DSCN_DISABLE_TOP_PROJECT=ON -DSCN_PEDANTIC=ON -DSCN_WERROR=OFF -DSCN_TESTS=ON -B build
cmake --build build --parallel -- -k
cmake --build build -- -k 0
ctest --output-on-failure --test-dir build
vs-arm64-crosscompile:
Expand Down
30 changes: 16 additions & 14 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,27 @@ To turn an ``input_range`` into a ``scannable_range``, ``scn::caching_view`` can
Result Types
------------

.. doxygentypedef:: scan_result_type
.. doxygenclass:: scn::scan_error
:members:
:undoc-members:

``scan`` and others return an object of type ``scan_result``, wrapped in a ``scan_expected``.
`std::expected on cppreference <https://en.cppreference.com/w/cpp/utility/expected>`_.

.. doxygentypedef:: scan_expected

.. doxygenfunction:: make_scan_result(scan_expected<ResultRange>&& result, scan_arg_store<Context, Args...>&& args)

.. doxygenclass:: scn::scan_result
.. doxygenstruct:: scan_expected
:members:
:undoc-members:

.. doxygenclass:: scn::scan_error
.. doxygenclass:: scn::expected
:members:
:undoc-members:

.. doxygenclass:: scn::expected
.. doxygentypedef:: scan_result_type

.. doxygenfunction:: make_scan_result(scan_expected<ResultRange>&& result, scan_arg_store<Context, Args...>&& args)

.. doxygenclass:: scn::scan_result
:members:
:undoc-members:

Format Strings
--------------
Expand Down Expand Up @@ -164,7 +166,7 @@ Its effects are different for each type it is used with:
* For other types, it has no effect

Type specifier
*************
**************

The type specifier determines how the data is to be scanned.
The type of the argument to be scanned determines what flags are valid.
Expand Down Expand Up @@ -203,7 +205,7 @@ Integer values are scanned as if by using ``std::from_chars``, except:
* - ``o``, ``O``
- ``from_chars`` with base 8. The base prefix is ``0o``, ``0O``, or just ``0``.
* - ``x``, ``X``
- ``from_chars`` with base 16. The base prefix is ``0x``, ``0X`.
- ``from_chars`` with base 16. The base prefix is ``0x``, ``0X``.
* - ``d``
- ``from_chars`` with base 10. No base prefix.
* - ``u``
Expand Down Expand Up @@ -270,7 +272,7 @@ Type specifier: booleans
- Meaning
* - ``s``
- Allows the textual representation (``true`` or ``false``).
* - ``b``, ``B``, ``d``, ``i``, ``o``, `O``, ``u``, ``x``, ``X``
* - ``b``, ``B``, ``d``, ``i``, ``o``, ``O``, ``u``, ``x``, ``X``
- Allows the integral/numeric representation (``0`` or ``1``).
* - none
- Allows for both the textual and the integral/numeric representation.
Expand Down Expand Up @@ -299,12 +301,12 @@ Contexts and Scanners
:members:
:undoc-members:

.. doxygenclass:: scn::scanner
.. doxygenstruct:: scn::scanner

Localization
------------

.. doxygenfunction:: scn::scan(const Locale &loc, Source &&source, format_string<Args...> format) -> scan_result_type<Source, Args...>
.. doxygenfunction:: scan(const Locale &loc, Source &&source, format_string<Args...> format) -> scan_result_type<Source, Args...>

.. doxygenfunction:: vscan(const Locale& loc, Range&& range, std::string_view format, scan_args_for<Range, char> args) -> vscan_result<Range>

Expand Down
13 changes: 12 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,18 @@ def configureDoxyfile(input_dir, output_dir):
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["breathe", "sphinx.ext.autosectionlabel"]
extensions = [
'breathe',
'sphinx.ext.autosectionlabel',
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.inheritance_diagram',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down

0 comments on commit f60b640

Please sign in to comment.