Skip to content

Add benchmark for Docutils #216

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

Merged
merged 10 commits into from
Sep 6, 2022
Merged
Show file tree
Hide file tree
Changes from 4 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
9 changes: 9 additions & 0 deletions doc/benchmarks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,15 @@ Pseudo-code of the benchmark::
See the `Dulwich project <https://www.dulwich.io/>`_.



docutils
--------

Use Docutils_ to convert Docutils' documentation to HTML.
Representative of building a medium-sized documentation set.

.. _Docutils: https://docutils.sourceforge.io/

fannkuch
--------

Expand Down
1 change: 1 addition & 0 deletions pyperformance/data-files/benchmarks/MANIFEST
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ deepcopy <local>
deltablue <local>
django_template <local>
dulwich_log <local>
docutils <local>
fannkuch <local>
float <local>
genshi <local>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
https://sourceforge.net/p/docutils/feature-requests/89/

At the very least I would suggest, docutils.nodes, the reader/writer/parser aliases, docutils.core, and the front end tools.

--------------------

https://sourceforge.net/p/docutils/feature-requests/89/#f2e1

any script.py
any css/dom-construct
any tex-macro

might be API

--------------------

https://sourceforge.net/p/docutils/feature-requests/89/#a0ff


> At the very least I would suggest, docutils.nodes, the
> reader/writer/parser aliases, docutils.core, and the front end tools.

The abstract base classes for reader, writer, parser, and transforms come to mind.
Also docutils.__init__ and the "plug-in API" for the components.

The modules and classes intended as part of the public API come with
comprehensive docstrings which are a good guide to differentiate core objects from
auxiliary, internal objects and ambiguous (non-core) cases
(that may be useful for clients or may be used by existing applications).

For the Docutils project version number, the document model (docutils.dtd, doctree.txt)
and the rST specification are equally important (unless they get their own version identifier).

Yes, the final document should be a collaborative effort and we may
improve/clean the code base in the process.
OTOH, Sphinx is so closely intertwined to Docutils that it, IMO,
deserves a special handling ensuring synchronised changes.
This may be extended to other projects that use non-core objects
and are ready to follow the development, test, and report back.


----------------
Loading