phpDocumentor 3.1.2 Guides not generating

241 views
Skip to first unread message

Brice Thrower

unread,
Sep 21, 2021, 4:46:51 PM9/21/21
to phpDocumentor
Hello,

I'm trying to create Guides on my project, but it's as if my phpdoc.dist.xml is ignoring the guide tag. Normal documentation is working fine and phpdoc 3.1.2 executes successfully. 

My steps to try out Guides were as follows
  1. Copy the files from getting-started into a folder documentation/docs/getting-started to try and get some guides working. 
  2. Copy the index guide from index into the base docs folder of my project (documentation/docs/index.rst)
  3. Add the guide tag to my phpdoc.dist.xml
I believe I've setup the configuration the right way but clearly I'm not doing something right here, because when I run phpdoc it does not setup the guide directory at all or put the guides in the Documentation section like it does on the https://docs.phpdoc.org/3.0/ side menu. 

Is there any phpdoc setup that I may have missed that would make it not process guides? I've attached the view of my project directory in which i'm trying to setup guides, as well as the phpdoc.dist.xml file that I'm currently working with. 

I would greatly appreciate any assistance,

Thanks,
Brice
phpdoc.dist.xml
Project Directory Layout.png

draco...@gmail.com

unread,
Sep 21, 2021, 4:56:54 PM9/21/21
to phpdoc...@googlegroups.com

Hi Brice,

 

The feature is still behind a feature toggle as it is in Alpha and not considered production-level stability. I do encourage you to use it, the more feedback the better 😊

 

You probably need to pass the feature toggle to the phpdoc command when you run it. If you add `--setting="guides.enabled=true"`; does it work now?

 

Kind regards,

 

Mike van Riel

--
You received this message because you are subscribed to the Google Groups "phpDocumentor" group.
To unsubscribe from this group and stop receiving emails from it, send an email to phpdocumento...@googlegroups.com.
To view this discussion on the web, visit https://groups.google.com/d/msgid/phpdocumentor/aaf6d7df-1198-4297-9657-516cf3988fa3n%40googlegroups.com.

Brice Thrower

unread,
Sep 21, 2021, 5:21:24 PM9/21/21
to phpDocumentor
YOOO this is sick!  It ran successfully, throwing some expected errors for links that I didn't copy over. 

Thank you for your help Mike, all good now!

Thanks,
Brice


Reply all
Reply to author
Forward
0 new messages