← Back to team overview

fenics team mailing list archive

Re: [Branch ~fenics-core/fenics-doc/main] Rev 100: Fix indentation bugs in documentation extraction

 

On Mon, Aug 30, 2010 at 12:34:15PM +0200, Kristian Ølgaard wrote:
> On 30 August 2010 11:58, Anders Logg <logg@xxxxxxxxx> wrote:
> > On Mon, Aug 30, 2010 at 10:49:13AM +0200, Kristian Шlgaard wrote:
> >> Nice, on a related note:
> >> 1) Why is Point being added to the mesh/index.rst twice? I couldn't
> >> figure this out from the generate script.
> >
> > I couldn't find this. Is the problem still there? Perhaps it
> > disappeared along the way.
> >
> I still see this, it's because
>
> #include <dolfin/mesh/Point.h>
>
> appears twice in dolfin/mesh/dolfin_mesh.h

ok, I've removed the extra include now.

> > Take a look at the generated documentation now and see if you can spot
> > any more problems. I think it looks very similar to the hand-written
> > Mesh.rst file.
>
> It looks good, now we just need to reduce the number of warnings.

I'll look at the inline issue. Other issues are some template-related
problems and the speed which can be improved (regex replacement for
the cross-links takes time).

--
Anders


> Kristian
>
> >
> >
> >> 2) We can remove some of the current 1231 warnings if we strip the
> >> 'inline'j keyword from function signatures, I don't think they add
> >> much additional info in a programmer's reference.
> >>
> >> Kristian
> >>
> >> On 30 August 2010 10:36,  <noreply@xxxxxxxxxxxxx> wrote:
> >> > ------------------------------------------------------------
> >> > revno: 100
> >> > committer: Anders Logg <logg@xxxxxxxxx>
> >> > branch nick: fenics-doc
> >> > timestamp: Mon 2010-08-30 10:33:47 +0200
> >> > message:
> >> >  Fix indentation bugs in documentation extraction
> >> > modified:
> >> >  source/programmers-reference/cpp/adaptivity/TimeSeries.rst
> >> >  source/programmers-reference/cpp/ale/ALE.rst
> >> >  source/programmers-reference/cpp/common/Array.rst
> >> >  source/programmers-reference/cpp/common/Set.rst
> >> >  source/programmers-reference/cpp/common/Timer.rst
> >> >  source/programmers-reference/cpp/common/Variable.rst
> >> >  source/programmers-reference/cpp/fem/Assembler.rst
> >> >  source/programmers-reference/cpp/fem/BasisFunction.rst
> >> >  source/programmers-reference/cpp/fem/BoundaryCondition.rst
> >> >  source/programmers-reference/cpp/fem/DirichletBC.rst
> >> >  source/programmers-reference/cpp/fem/DofMap.rst
> >> >  source/programmers-reference/cpp/fem/EqualityBC.rst
> >> >  source/programmers-reference/cpp/fem/FiniteElement.rst
> >> >  source/programmers-reference/cpp/fem/Form.rst
> >> >  source/programmers-reference/cpp/fem/GenericDofMap.rst
> >> >  source/programmers-reference/cpp/fem/PeriodicBC.rst
> >> >  source/programmers-reference/cpp/fem/SystemAssembler.rst
> >> >  source/programmers-reference/cpp/fem/VariationalProblem.rst
> >> >  source/programmers-reference/cpp/function/Constant.rst
> >> >  source/programmers-reference/cpp/function/Data.rst
> >> >  source/programmers-reference/cpp/function/Expression.rst
> >> >  source/programmers-reference/cpp/function/Function.rst
> >> >  source/programmers-reference/cpp/function/FunctionSpace.rst
> >> >  source/programmers-reference/cpp/function/GenericFunction.rst
> >> >  source/programmers-reference/cpp/function/SpecialFunctions.rst
> >> >  source/programmers-reference/cpp/function/SubSpace.rst
> >> >  source/programmers-reference/cpp/io/File.rst
> >> >  source/programmers-reference/cpp/la/CholmodCholeskySolver.rst
> >> >  source/programmers-reference/cpp/la/EpetraKrylovSolver.rst
> >> >  source/programmers-reference/cpp/la/EpetraLUSolver.rst
> >> >  source/programmers-reference/cpp/la/EpetraMatrix.rst
> >> >  source/programmers-reference/cpp/la/EpetraSparsityPattern.rst
> >> >  source/programmers-reference/cpp/la/EpetraVector.rst
> >> >  source/programmers-reference/cpp/la/GenericLUSolver.rst
> >> >  source/programmers-reference/cpp/la/GenericLinearSolver.rst
> >> >  source/programmers-reference/cpp/la/GenericMatrix.rst
> >> >  source/programmers-reference/cpp/la/GenericSparsityPattern.rst
> >> >  source/programmers-reference/cpp/la/GenericTensor.rst
> >> >  source/programmers-reference/cpp/la/GenericVector.rst
> >> >  source/programmers-reference/cpp/la/ITLKrylovSolver.rst
> >> >  source/programmers-reference/cpp/la/KrylovSolver.rst
> >> >  source/programmers-reference/cpp/la/LinearSolver.rst
> >> >  source/programmers-reference/cpp/la/Matrix.rst
> >> >  source/programmers-reference/cpp/la/PETScBaseMatrix.rst
> >> >  source/programmers-reference/cpp/la/PETScKrylovMatrix.rst
> >> >  source/programmers-reference/cpp/la/PETScKrylovSolver.rst
> >> >  source/programmers-reference/cpp/la/PETScLUSolver.rst
> >> >  source/programmers-reference/cpp/la/PETScMatrix.rst
> >> >  source/programmers-reference/cpp/la/PETScObject.rst
> >> >  source/programmers-reference/cpp/la/PETScPreconditioner.rst
> >> >  source/programmers-reference/cpp/la/PETScUserPreconditioner.rst
> >> >  source/programmers-reference/cpp/la/PETScVector.rst
> >> >  source/programmers-reference/cpp/la/SLEPcEigenSolver.rst
> >> >  source/programmers-reference/cpp/la/STLMatrix.rst
> >> >  source/programmers-reference/cpp/la/Scalar.rst
> >> >  source/programmers-reference/cpp/la/SingularSolver.rst
> >> >  source/programmers-reference/cpp/la/SparsityPattern.rst
> >> >  source/programmers-reference/cpp/la/TrilinosPreconditioner.rst
> >> >  source/programmers-reference/cpp/la/UmfpackLUSolver.rst
> >> >  source/programmers-reference/cpp/la/Vector.rst
> >> >  source/programmers-reference/cpp/la/uBLASILUPreconditioner.rst
> >> >  source/programmers-reference/cpp/la/uBLASKrylovMatrix.rst
> >> >  source/programmers-reference/cpp/la/uBLASKrylovSolver.rst
> >> >  source/programmers-reference/cpp/la/uBLASMatrix.rst
> >> >  source/programmers-reference/cpp/la/uBLASPreconditioner.rst
> >> >  source/programmers-reference/cpp/la/uBLASVector.rst
> >> >  source/programmers-reference/cpp/log/Event.rst
> >> >  source/programmers-reference/cpp/log/LogStream.rst
> >> >  source/programmers-reference/cpp/log/Progress.rst
> >> >  source/programmers-reference/cpp/log/Table.rst
> >> >  source/programmers-reference/cpp/main/MPI.rst
> >> >  source/programmers-reference/cpp/math/Lagrange.rst
> >> >  source/programmers-reference/cpp/math/Legendre.rst
> >> >  source/programmers-reference/cpp/mesh/BoundaryMesh.rst
> >> >  source/programmers-reference/cpp/mesh/Box.rst
> >> >  source/programmers-reference/cpp/mesh/Cell.rst
> >> >  source/programmers-reference/cpp/mesh/CellType.rst
> >> >  source/programmers-reference/cpp/mesh/DomainBoundary.rst
> >> >  source/programmers-reference/cpp/mesh/DynamicMeshEditor.rst
> >> >  source/programmers-reference/cpp/mesh/Edge.rst
> >> >  source/programmers-reference/cpp/mesh/Face.rst
> >> >  source/programmers-reference/cpp/mesh/Facet.rst
> >> >  source/programmers-reference/cpp/mesh/FacetCell.rst
> >> >  source/programmers-reference/cpp/mesh/Interval.rst
> >> >  source/programmers-reference/cpp/mesh/LocalMeshData.rst
> >> >  source/programmers-reference/cpp/mesh/Mesh.rst
> >> >  source/programmers-reference/cpp/mesh/MeshConnectivity.rst
> >> >  source/programmers-reference/cpp/mesh/MeshData.rst
> >> >  source/programmers-reference/cpp/mesh/MeshEditor.rst
> >> >  source/programmers-reference/cpp/mesh/MeshEntity.rst
> >> >  source/programmers-reference/cpp/mesh/MeshEntityIterator.rst
> >> >  source/programmers-reference/cpp/mesh/MeshFunction.rst
> >> >  source/programmers-reference/cpp/mesh/MeshPartitioning.rst
> >> >  source/programmers-reference/cpp/mesh/MeshTopology.rst
> >> >  source/programmers-reference/cpp/mesh/Point.rst
> >> >  source/programmers-reference/cpp/mesh/PrimitiveIntersector.rst
> >> >  source/programmers-reference/cpp/mesh/Rectangle.rst
> >> >  source/programmers-reference/cpp/mesh/SubDomain.rst
> >> >  source/programmers-reference/cpp/mesh/SubMesh.rst
> >> >  source/programmers-reference/cpp/mesh/UnitCircle.rst
> >> >  source/programmers-reference/cpp/mesh/UnitCube.rst
> >> >  source/programmers-reference/cpp/mesh/UnitInterval.rst
> >> >  source/programmers-reference/cpp/mesh/UnitSphere.rst
> >> >  source/programmers-reference/cpp/mesh/UnitSquare.rst
> >> >  source/programmers-reference/cpp/mesh/Vertex.rst
> >> >  source/programmers-reference/cpp/nls/NewtonSolver.rst
> >> >  source/programmers-reference/cpp/nls/NonlinearProblem.rst
> >> >  source/programmers-reference/cpp/ode/ComplexODE.rst
> >> >  source/programmers-reference/cpp/ode/Method.rst
> >> >  source/programmers-reference/cpp/ode/ODE.rst
> >> >  source/programmers-reference/cpp/ode/ODECollection.rst
> >> >  source/programmers-reference/cpp/ode/Sample.rst
> >> >  source/programmers-reference/cpp/ode/cGqMethod.rst
> >> >  source/programmers-reference/cpp/ode/dGqMethod.rst
> >> >  source/programmers-reference/cpp/parameter/GlobalParameters.rst
> >> >  source/programmers-reference/cpp/parameter/Parameter.rst
> >> >  source/programmers-reference/cpp/parameter/Parameters.rst
> >> >  source/programmers-reference/cpp/plot/FunctionPlotData.rst
> >> >  source/programmers-reference/cpp/quadrature/BarycenterQuadrature.rst
> >> >  source/programmers-reference/cpp/quadrature/GaussQuadrature.rst
> >> >  source/programmers-reference/cpp/quadrature/GaussianQuadrature.rst
> >> >  source/programmers-reference/cpp/quadrature/LobattoQuadrature.rst
> >> >  source/programmers-reference/cpp/quadrature/RadauQuadrature.rst
> >> >  utils/generate_cpp_doc.py
> >> > The size of the diff (4255 lines) is larger than your specified limit of 1000 lines
> >> >
> >> >
> >> > You are subscribed to branch lp:fenics-doc.
> >> > To unsubscribe from this branch go to https://code.launchpad.net/~fenics-core/fenics-doc/main/+edit-subscription
> >> >
> >>
> >> _______________________________________________
> >> Mailing list: https://launchpad.net/~fenics
> >> Post to     : fenics@xxxxxxxxxxxxxxxxxxx
> >> Unsubscribe : https://launchpad.net/~fenics
> >> More help   : https://help.launchpad.net/ListHelp
> >
> >

--
Anders



References