varspool / sphpdox Goto Github PK
View Code? Open in Web Editor NEWPHPDoc to Sphinx/ReStructured Text API documentation tool
License: GNU General Public License v3.0
PHPDoc to Sphinx/ReStructured Text API documentation tool
License: GNU General Public License v3.0
Makes it much easier to parse information from docblocks
Would you consider making some releases for this project? Even if they're 0.x that's ok with me: I'm using it for baleen/migrations and some related packages.
Libraries shouldn't include this
Hi,
it would be awesome if there would be some kind of class TOC listing the members. Example: http://api.symfony.com/3.0/Symfony/Bridge/Doctrine/ContainerAwareEventManager.html
Hi,
if a class is a child of another class or implements an interface, it would be great if this would be reflected in the docs, ideally clickable.
Hi,
in my PHPDocs I reference other classes like this:
This class is a factory for {@see FooBar} instances.
Would it be possible, to support this and create links to the referenced classes?
I can't update some of my global SF2 packages since sphpdox master branch now requires Symfony 3 and there are no releases for that. Could a release of a former version for SF 2.* be made? Or am I missing something? Thanks!
When I set an output directory, it looks like the exclude option is also being set to an empty string, even though I haven't set that option. The result is that in Process.php line 124, an element with empty text is added to the array. Then, the comparison in 136 is always true, and no namespaces get processed.
For my project I'm not excluding anything, so commenting out 124 fixes it for me, but I'm guessing that a full solution would take digging into the $input object.
Many thanks! This is going to save countless hours on a documentation project!
Hi,
currently, I'm relying on a specific commit due to the more modern Symfony versions: "sphpdox/sphpdox": "dev-master#bc149dd0a0e3ec1f3e0d24d752552f54bfa17a53",
This works but has the problem of Symfony Insight raising a warning for example.
Could you release a new version?
I like your project and would like to use it for documentation of my project (http://github.com/atk4/data).
After the initial run if I change the .rst structure, would it be possible for the parser to keep my changes and only update method definitions?
If it's not possible, could you suggest how to implement this?
Hello
I'd installed Sphpdox using composer.
In my project structure it looks like:
root
├── project folders
└── vendor
├──autoload.php
└──sphpdox
└──sphpdox.php
So trying to run sphpdox.php return exception in this string:
require __DIR__ . '/vendor/autoload.php';
Using composer files structure I've changed it to:
require __DIR__ . '/../../autoload.php';
Thanks
Hi!
I cannot found the reference about usage sphpdox to generate rst docs for global defined functions and vars.
Is it possible at this time?
Thanks.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.