GithubHelp home page GithubHelp logo

Comments (7)

mvriel avatar mvriel commented on August 20, 2024

Consider creating a sphinx writer instead of building a custom solution

from phpdocumentor.

jaikdean avatar jaikdean commented on August 20, 2024

I would love to see this happen.

I've made a start on a DocBlox_Transformer_Writer_Sphinx class which will output for Sphinx PHP Domain but only a handful of bits and pieces are working thus far.

If I get something usable going I'll make sure to make a pull request or at least release it separately and let you know.

from phpdocumentor.

mvriel avatar mvriel commented on August 20, 2024

That would ROCK! Already looking forward!

from phpdocumentor.

jaikdean avatar jaikdean commented on August 20, 2024

It's far from complete and likely contains plenty of bugs, but I've put what I've created so far in a branch. If you just run your transform using the template sphinx you will get a series of .rst files compatible with Sphinx and PHP Domain.

I've got this generating the beginnings of class and interface documentation for an internal project.

from phpdocumentor.

mvriel avatar mvriel commented on August 20, 2024

Assigned to @ashnazg as discussed

from phpdocumentor.

mvriel avatar mvriel commented on August 20, 2024

This issue has been implemented as a separate application that is inspired on Sphinx; see https://github.com/phpDocumentor/Scrybe for the repository and usable alpha

from phpdocumentor.

AndreKR avatar AndreKR commented on August 20, 2024

How do I tell phpDocumentor about an available Scrybe document? In other words, how is user story 4 ("As a user I want to access the (pieces of) HTML generated documentation from the main menu of phpDocumentor so that I can easily access the docs") being solved?

from phpdocumentor.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.