Skip to content
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

error messages during: make sphinx-clad #631

Closed
bradbell opened this issue Sep 30, 2023 · 3 comments
Closed

error messages during: make sphinx-clad #631

bradbell opened this issue Sep 30, 2023 · 3 comments

Comments

@bradbell
Copy link

Steps to reproduce:

git clone https://github.com/vgvassilev/clad.git clad.git
cd clad.git
mkdir build
cd build
cmake \
   -S .. \
   -B . \
   -D "LLVM_EXTERNAL_LIT=$(which lit)" \
   -D CLAD_INCLUDE_DOCS=ON \
   -D CLAD_ENABLE_SPHINX=ON
make sphinx-clad

Result:

build>make sphinx-clad
[100%] Generating sphinx user documentation into "/home/bradbell/repo/clad.git/build/docs/userDocs/build"
/home/bradbell/repo/clad.git/docs/userDocs/source/index.rst:73: ERROR: Unknown directive type "comment".

.. comment::

   .. todo::

      Add more features such as error estimation, custom derivatives, class type support etc.
/home/bradbell/repo/clad.git/docs/userDocs/source/user/InstallationAndUsage.rst:82: ERROR: Error in "code-block" directive:
maximum 1 argument(s) allowed, 15 supplied.

.. code-block:: bash
  mamba create -n xeus-clad -c conda-forge clad xeus-cling jupyterlab
  conda activate xeus-clad
  jupyter notebook
/home/bradbell/repo/clad.git/docs/userDocs/source/user/UsingClad.rst:2: WARNING: Duplicate explicit target name: "demo".
/home/bradbell/repo/clad.git/docs/userDocs/source/user/UsingVectorMode.rst: WARNING: document isn't included in any toctree
/home/bradbell/repo/clad.git/docs/userDocs/source/user/UsingClad.rst:130: WARNING: undefined label: 'api_reference_clad_differentiate'
/home/bradbell/repo/clad.git/docs/userDocs/source/user/UsingClad.rst:603: WARNING: undefined label: 'pushforward and pullback functions'
[100%] Built target sphinx-clad
@vgvassilev
Copy link
Owner

Cc: @Krishna-13-cyber, @parth-07

@vgvassilev
Copy link
Owner

@bradbell, would that fix it:

diff --git a/docs/userDocs/source/user/InstallationAndUsage.rst b/docs/userDocs/source/user/InstallationAndUsage.rst
index 89aedd8..0d030ad 100644
--- a/docs/userDocs/source/user/InstallationAndUsage.rst
+++ b/docs/userDocs/source/user/InstallationAndUsage.rst
@@ -80,6 +80,7 @@ xeus-cling <https://github.com/jupyter-xeus/xeus-cling> provides a Jupyter kerne
 To set up your environment, use:
 
 .. code-block:: bash
+
   mamba create -n xeus-clad -c conda-forge clad xeus-cling jupyterlab
   conda activate xeus-clad
   jupyter notebook

@vgvassilev
Copy link
Owner

Hi @bradbell, thanks a lot for the report. It was fixed in #663.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants