executablebooks / sphinx-panels

A sphinx extension for creating panels in a grid layout
https://sphinx-panels.readthedocs.io
MIT License
83 stars 20 forks source link

Unknown directive type "panels".snooty(DocUtilsParseError) #72

Closed sistia01 closed 3 years ago

sistia01 commented 3 years ago

Describe the problem

I have followed the steps outlined here (https://sphinx-panels.readthedocs.io/en/latest/) but ma having some trouble with sphinx-panels. The extension has been dowloaded in my local folders but when using VSCode I get the error Unknown directive type "panels" .snooty(DocUtilsParseError) but the panels show-up so I figured this was just a warning. I recently uploaded all of my documentation to ReadTheDocs and received an error that said that the extension does not exist and therefore my website could not be built -- the only way that I am able to build the site is by deleting the extension from the extensions = (in conf.py) . Is there something that I am missing?

Link to your repository or website

https://github.com/sistia01/Giotto-Sphinx-Website

Steps to reproduce

.. panels:: :body: text-center :container: container-md pb-4 :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2

.. image:: images/dataset_page/mini_seqFISH.png
    :target: subsections/datasets/mini_visium.rst

.. link-button:: /subsections/datasets/seqFISH_cortex.rst
    :type: ref
    :text: Mini SeqFish
    :classes: btn-outline-primary btn-block stretched-link

---

.. image:: images/dataset_page/mini_STARmap.png
    :target: ../../build/html/subsections/datasets/mini_visium.html

.. link-button:: subsections/datasets/human_CyCIF_PDAC.rst
    :type: ref
    :text: Mini STARmap
    :classes: btn-outline-primary btn-block stretched-link

---

.. image:: images/dataset_page/mini_visium.png
    :target: ../../build/html/subsections/datasets/mini_visium.html

.. link-button:: ../../build/html/subsections/datasets/mini_visium.html
    :type: ref
    :text: Mini Visium
    :classes: btn-outline-primary btn-block stretched-link 

The version of Python you're using

Python 3.8.5 64-bit ('base':conda)

Your operating system

OSX

Versions of your packages

No response

Additional context

No response

welcome[bot] commented 3 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

chrisjsewell commented 3 years ago

Heya, Currently I would note in your conf.py the extension is commented out?

But mainly I would note #67, i.e. you might want to try out sphinx-design

sistia01 commented 3 years ago

Hi, yes! I commented it out because I'd get a terminal error -- could not build website.

Thanks! I'll try sphinx-design instead!

sistia01 commented 3 years ago

Hi Chris, sorry to reach out again about this. I am running into the same error with sphinx-design. Any idea on what I can do here? I am unable to build the website (attaching a screenshot of the error message from ReadTheDocs).

Screen Shot 2021-08-27 at 3 21 51 PM
chrisjsewell commented 3 years ago

Heya, two things here:

  1. you don’t seem to have sphinx-design in your requirements.txt?
  2. In the extensions list, it should be sphinx_design not sphinx-design
sistia01 commented 3 years ago

Worked! Thanks so much!

chrisjsewell commented 3 years ago

🎉