search

stlab / libraries

ASL libraries will be migrated here in the stlab namespace, new libraries will be created here.
https://stlab.cc
Boost Software License 1.0
659 stars 65 forks source link

Is documentation generation broken? #510

Open mnesarco opened 1 year ago

mnesarco commented 1 year ago

Hi Friends, Online docs seems outdated, so I am trying to generate it locally, but the generate_docs.sh script fails with a lot of syntax errors:

~/tmp/stlab-libraries/docs$ ./generate_docs.sh

Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/utility.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/utility.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/memory.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/memory.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/algorithm/reverse.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/algorithm/reverse.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/functional.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/functional.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/scope.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/scope.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/pre_exit.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/pre_exit.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/iterator/set_next.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/iterator/set_next.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/enum_ops.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/enum_ops.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/test/model.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/test/model.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/utility.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/utility.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/traits.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/traits.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/main_executor.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/main_executor.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/default_executor.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/default_executor.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/variant.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/variant.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/concurrency.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/concurrency.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/tuple_algorithm.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/tuple_algorithm.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/future.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/future.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/executor_base.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/executor_base.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/immediate_executor.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/immediate_executor.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/set_current_thread_name.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/set_current_thread_name.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/optional.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/optional.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/channel.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/channel.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/serial_queue.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/serial_queue.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/ready_future.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/ready_future.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/system_timer.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/system_timer.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/progress.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/progress.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/task.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/task.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/await.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/concurrency/await.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/forest_algorithms.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/forest_algorithms.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/copy_on_write.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/copy_on_write.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/forest.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/forest.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
Processing /home/mnesarco/tmp/stlab-libraries/docs/../stlab/version.hpp
hyde --access-filter-protected --namespace-blacklist=detail --hyde-update "/home/mnesarco/tmp/stlab-libraries/docs/../stlab/version.hpp"
Traceback (most recent call last):
  File "/tmp/stlabpy/bin/hyde", line 5, in <module>
    from hyde.main import main
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/main.py", line 6, in <module>
    from hyde.engine import Engine
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/engine.py", line 5, in <module>
    from hyde.exceptions import HydeException
  File "/tmp/stlabpy/lib/python3.10/site-packages/hyde/exceptions.py", line 10
    raise HydeException(message), None, tb
                                ^
SyntaxError: invalid syntax
mnesarco commented 1 year ago

Apparently hyde only works with python2. So it is basically unmaintained. Is there another way to generate the docs?

https://github.com/hyde/hyde/issues/306

sean-parent commented 1 year ago

I run hyde in docker https://github.com/stlab/libraries/tree/main/docs#running-hyde-in-docker There are a couple of issues with hyde right now that still require manual editing of the results for stlab docs. Hyde will strip additional yaml tags instead of preserving them issue 75. We use an additional tag for examples. Hyde also changes how the yaml is quoted which breaks our use of markdown in yaml text. This may be fixable on our side. For example;

This:

      - description: |
          Specify the mode by which the serial queue runs tasks:

          - `schedule_mode::single` &mdash; Yield to the executor between runs of individual tasks. This mode is preferrable if you are expecting tasks to take a long amount of time.
          - `schedule_mode::all` &mdash; Yield to the executor once all tasks available at the start of processing have been run. This mode is preferrable if you are expecting tasks to take a short amount of time.

Turns into this - and then fails markdownify because \n is not a yaml new-line. We might be able to fix this by replacing \n characters with liquid. I haven't tried.

      - description: "Specify the mode by which the serial queue runs tasks:\n\n- `schedule_mode::single` &mdash; Yield to the executor between runs of individual tasks. This mode is preferrable if you are expecting tasks to take a long amount of time.\n- `schedule_mode::all` &mdash; Yield to the executor once all tasks available at the start of processing have been run. This mode is preferrable if you are expecting tasks to take a short amount of time.\n"

This issue may be a Jekyll Issue and not a Hyde issue - I haven't fully investigated but \n does look to be a valid quoted character in yaml strings (https://yaml.org/spec/1.2.2/#rule-ns-esc-line-feed).

sean-parent commented 1 year ago

I run hyde in docker https://github.com/stlab/libraries/tree/main/docs#running-hyde-in-docker There are a couple of issues with hyde right now that still require manual editing of the results for stlab docs. Hyde will strip additional yaml tags instead of preserving them issue 75. We use an additional tag for examples. Hyde also changes how the yaml is quoted which breaks our use of markdown in yaml text. This may be fixable on our side. For example;

This:

      - description: |
          Specify the mode by which the serial queue runs tasks:

          - `schedule_mode::single` &mdash; Yield to the executor between runs of individual tasks. This mode is preferrable if you are expecting tasks to take a long amount of time.
          - `schedule_mode::all` &mdash; Yield to the executor once all tasks available at the start of processing have been run. This mode is preferrable if you are expecting tasks to take a short amount of time.

Turns into this - and then fails markdownify because \n is not a yaml new-line. We might be able to fix this by replacing \n characters with liquid. I haven't tried.

      - description: "Specify the mode by which the serial queue runs tasks:\n\n- `schedule_mode::single` &mdash; Yield to the executor between runs of individual tasks. This mode is preferrable if you are expecting tasks to take a long amount of time.\n- `schedule_mode::all` &mdash; Yield to the executor once all tasks available at the start of processing have been run. This mode is preferrable if you are expecting tasks to take a short amount of time.\n"

This issue may be a Jekyll Issue and not a Hyde issue - I haven't fully investigated but \n does look to be a valid quoted character in yaml strings (https://yaml.org/spec/1.2.2/#rule-ns-esc-line-feed).

mnesarco commented 1 year ago

Last commit to hyde repo was 7 years ago. Probably it is better to change to something more actively maintained.

sean-parent commented 1 year ago

Hyde isn't super active, but there have been many commits that are more recent - https://github.com/adobe/hyde/commits/master

mnesarco commented 1 year ago

I am sorry for the confusion. I was confusing it with https://github.com/hyde/hyde

mnesarco commented 1 year ago

What I want is to read the current docs in its html form. The public online docs are outdated (1.6.0). What can I do to generate them? I have found some scripts in stlab/docs like generate_docs.sh and build.sh but those are not that generate the html docs.

Is there an easy way to just generate the html docs?

sean-parent commented 1 year ago

Ah - I see. The HTML docs are generated by github pages from main on every commit to main. No need to manually regenerate them. The docs are current (see, for example https://stlab.cc/libraries/concurrency/default_executor.hpp/).

mnesarco commented 1 year ago

Oh, Thank you. stlab.cc points to an outdated version: https://stlab.cc/concurrency/2017/05/11/concurrency.html

mnesarco commented 1 year ago

Main page is outdated. And links to a very old docs: image

sean-parent commented 1 year ago

The link you site is a blog post - not the API docs. But I'll keep this issue open to update the front page.

mnesarco commented 1 year ago

Thank you. The outdated site front page is a bit confusing.