Skip to content

Conversation

itziakos
Copy link
Member

This pr provides a major refactoring effort forv section doc (former refactor doc). the package layout has been rearranged into syles, sections, parsiing definition, renderers

implements #13

@itziakos itziakos self-assigned this Oct 15, 2014
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be an absolute import?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, there are a number of problems with this PR currently and it is not ready for review (please note the in-progress label) sorry for the confusion.

@coveralls
Copy link

Coverage Status

Coverage decreased (-80.58%) when pulling 9593657 on feature/styles into 552210b on master.

itziakos and others added 7 commits October 18, 2014 02:57
# By itziakos
# Via itziakos
* origin/feature/styles:
  fix tests
  update the section methods
  start updading the section rendering methods
  better separate the items and thier parsing constructors from the renderers
  add a subpackage for renderers
  update tests
  minor cleanup
  minor cleanup
  rework class and function tests to old_style tests
  remove unused classes
  move code for old_styles to the styles module
  provide eaiser access to the Items and fix code
  factor out section refactoring functions to the sections module
  subclass namedtuple
  use the Item as a base class
  factor out Item
@itziakos
Copy link
Member Author

itziakos commented Mar 2, 2015

@sjagoe, This PR is ready for review now. The main feature is the ability to fine tune the rendering behaviour thought defining new rendering Styles by combining the various component (see updated documentation).

The new components are:

  • A new style class is added to dispatch rendering for each autodoc type to a DocRender instance.
    • The previous default style is now called old_style. New styles will be added at a later PR.
  • A revamped BaseDoc -> DocRender class detects sections and despaches further rendering of each section based of a mapping between section name and a tuple of section rendering factory, item parser and item render.
  • A set of basic section rendering factories are provided in the sections subpackage.
  • A set of item definitions is provided in the items subpackage.
  • A set of item renderers is provided in the renderers subpackage.

Tests have been also updated.

@sjagoe
Copy link
Contributor

sjagoe commented Mar 5, 2015

I'll try to look at it today.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can use a better name. What is old style? Is it what was used in refactordoc? If so, call it that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes this is the style that refactordoc uses, but I want to discourage its use. I could call it something like simple.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

renamed to legacy

itziakos added a commit that referenced this pull request Aug 7, 2015
@itziakos itziakos merged commit 37fad9b into master Aug 7, 2015
@itziakos itziakos deleted the feature/styles branch August 7, 2015 10:58
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

Successfully merging this pull request may close these issues.

4 participants